DigiCert ONE

O DigiCert® ONE é uma plataforma de PKI moderna que fornece uma base escalonável para implementações de PKI rápidas e flexíveis. As APIs DigiCert ONE fornecem uma interface poderosa para gerenciar seus certificados e dispositivos, personalizando e automatizando fluxos de trabalho, e integrando o DigiCert ONE com suas ferramentas de gerenciamento de PKI existentes.

DigiCert ONE inclui APIs para gerenciar atividades encontradas nestes consoles:

Início

Antes de usar as APIs DigiCert ONE, você precisa:

  • Conta DigiCert ONE
  • DigiCert ONE API key
  • Capacidade de fazer solicitações REST API

Crie uma chave de API

Para criar uma nova chave de API:

  1. Faça login em sua conta DigiCert ONE.
  2. Navegue até o console do Gerenciador de contas.
  3. No menu à esquerda, selecione Acessar tokens > de API.
  4. Selecione Criar token de API.
  5. Preencha o formulário para criar a chave.

Cada chave de API é exibida apenas uma vez. Não há formas de recuperar uma chave de API perdida. Se você perder uma chave de API, revogue-a e gere uma nova.

Autenticação

As APIs DigiCert ONE usam autenticação baseada em cabeçalho. Cada solicitação inclui o cabeçalho HTTP personalizado x‑api‑key. Use sua própria chave de API como o valor para este cabeçalho ao enviar suas solicitações.

Por exemplo, aqui está uma solicitação ao endpoint para a criação de um novo dispositivo:

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 Base

Use este URL base para construir solicitações de API DigiCert ONE:

generic
https://one.digicert.com

Cadeias de consulta de URL

Alguns pontos de extremidade usam cadeias de consulta de URL para filtrar resultados. Para anexar strings de consulta ao URL do terminal, use ?. Para anexar strings de consulta adicionais, use &.

Este exemplo usa a string de consulta division_id para filtrar os resultados para a divisão especificada:

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

Solicitações

Todas as solicitações são enviadas por meio de URLs RESTful usando recursos REST, incluindo autenticação baseada em cabeçalho e tipos de solicitação JSON.

A codificação para conjuntos de caracteres de dados para solicitações é UTF-8. Uma solicitação bem formada usa a porta 443 e especifica o agente do usuário e os cabeçalhos HTTP de comprimento de conteúdo.

Métodos

As APIs DigiCert ONE usam métodos HTTP padrão, incluindo:

  • GET
  • POST
  • PUT
  • DELETE

Corpo

Salvo indicação em contrário, a maioria das solicitações exige a passagem de dados formatados em JSON ou XML. Os valores suportados para o cabeçalho Content-Type incluem:

  • application/json

Respostas

Respostas contemplam cabeçalhos e um corpo. A formatação do corpo da resposta depende do tipo de conteúdo que você especifica na solicitação.

Para obter mais informações sobre códigos de resposta de cabeçalho HTTP individuais, consulte Glossário - Cabeçalhos.