DigiCert ONE

DigiCert® ONE 是一款現代的 PKI 平台,為快速和彈性 PKI 部署提供可擴充的基礎。DigiCert ONE API 提供管理您的憑證和裝置、自訂和自動化工作流程、以及整合 DigiCert ONE 與您現有的 PKI 管理工具的強大介面。

DigiCert ONE 包括在這些主控台中找到的管理活動的 API:

開始使用

在您可以使用 DigiCert ONE API 前,您需要:

  • DigiCert ONE 帳戶
  • DigiCert ONE API 密鑰
  • 提出 REST API 要求的能力

建立 API 密鑰

若要建立新的 API 密鑰:

  1. 登入您的 DigiCert ONE 帳戶。
  2. 導覽到帳戶管理器主控台。
  3. 從左側功能表中,選取存取 > API 令牌
  4. 選取建立 API 令牌
  5. 填寫表格以建立密鑰。

每個 API 密鑰僅顯示一次。沒有擷取遺失的 API 密鑰的方式。如果您曾遺失 API 密鑰,您需要撤銷遺失的密鑰,然後產生一個新的。

驗證

DigiCert ONE API 使用標頭形式的身份驗證。每個要求都包括自訂的 HTTP 標頭 x‑api‑key。當您提交您的要求時,使用您自己的 API 密鑰作為此標頭的值。

例如,以下是對建立新裝置的端點的要求。

cURL
curl -X POST \
  'https://one.digicert.com/iot/api/v1/device' \
  -H 'x-api-key: {{api_key}}' \
  -H 'Content-Type: application/json' \
  -d '{
    "division_id": {{division_id}},
    "device_identifier": "MyDevice",
    "device_profile_id": {{device_profile_id}}
  }'
Python
import requests

url = "https://stage.one.digicert.com/iot/api/v1/device"

payload = "{\n  \"division_id\": {{division_id}},\n  \"device_identifier\": \"MyDevice\",\n  \"device_profile_id\": {{device_profile_id}}\n}"
headers = {
  'x-api-key': {{api_key}},
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
Go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://stage.one.digicert.com/iot/api/v1/device"
  method := "POST"

  payload := strings.NewReader("{\n  \"division_id\": {{division_id}},\n  \"device_identifier\": \"MyDevice\",\n  \"device_profile_id\": {{device_profile_id}}\n}")

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("x-api-key", {{api_key}})
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}
NodeJS
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://stage.one.digicert.com/iot/api/v1/device',
  'headers': {
    'x-api-key': {{api_key}},
    'Content-Type': 'application/json'
  },
  body: "{\n  \"division_id\": {{division_id}},\n  \"device_identifier\": \"MyDevice\",\n  \"device_profile_id\": {{device_profile_id}}\n}"

};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

基礎 URL

使用此基礎 URL 建構 DigiCert ONE API:

generic
https://one.digicert.com

URL 查詢字串

有些端點使用 URL 查詢字串篩選結果。若要附加查詢字串到端點 URL,請使用 ?.若要附加其他查詢字串,請使用 &

此範例使用 division_id 查詢字串篩選到指定分部的結果。

generic
https://one.digicert.com/iot/api/v1/device/{{device_identifier}}?division_id={{division_id}}

要求

所有 API 要求都使用 REST 功能透過 RESTful URL 提交,包括標頭形式的身份驗證和 JSON 要求類型。

要求的資料字元集編碼是 UTF-8。語式正確的要求使用連接埠 443,而且有指定的使用者代理程式內容長度 HTTP 標頭。

方法

DigiCert ONE API 使用標準 HTTP 方法,包括:

  • GET
  • POST
  • PUT
  • DELETE

內文

除非另有註明,否則大多數要求需要通過 JSON 或 XML 格式的資料。Content-Type 標題的支援值包括:

  • application/json

回應

回應由標頭和內文組成。回應本文的格式視您在要求中指定的內容類型而定。

如需更多有關個別 HTTP 標頭回應代碼的資訊,請參閱詞彙 – 標頭