API служб

API служб DigiCert - это мощный API, который позволяет автоматизировать типовые процессы, связанные с сертификатами, чтобы сэкономить время и оптимизировать управление сертификатами. API служб использует архитектурные требования к организации взаимодействия на основе передачи статуса представления (соглашения RESTful) и является простым в использовании.

Почему необходимо использовать данное дополнение?

  • Доступ ко всем функциям, имеющимся в CertCentral, при отсутствии необходимости регистрации в платформе.
  • Настройка и автоматизация практически любого рабочего процесса в рамках платформы управления сертификатами.
  • Создайте собственную версию платформы с учетом особенностей вашей организации.
  • Бесшовная интеграция с имеющимися у вас инструментами.

Базовый URL-адрес

Используйте данный базовый URL-адрес при создании запросов API:

bash
https://www.digicert.com/services/v2

На странице каждой конечной точки представлена только последняя часть URL-адреса конечной точки (например, /заказы). Не забудьте добавить базовый URL-адрес к конечной точке при создании запросов.

Строки запросов URL-адресов

Некоторые конечные точки используют строки запросов URL-адресов для фильтрации результатов. Строки запросов URL-адресов добавляются к URL-адресам конечных точек, использующим ?, с добавленными дополнительными строками запросов, использующими &.

В данном примере используется строка запроса container_id для фильтрации результатов для отдельного контейнера. Строка запросов также используется здесь limit для возврата только десяти результатов.

bash
https://www.digicert.com/services/v2/user?container_id=123&limit=10

Запросы

Все запросы API отправляются на URL-адреса RESTful, с использованием функцией REST, в том числе аутентификации на основе заголовков и типов запросов JSON/XML.

В качестве набора символов для обозначения данных, декодируемых в запросах, используется UTF-8. Правильно составленный запрос использует порт 443 и имеет соответствующие заголовки, в которых указан пользователь-агент и контент-длина.

Метод

API служб DigiCert использует данные стандартные методы HTTP:

  • GET
  • POST
  • PUT
  • HEAD
  • DELETE

Тело

Большинство запросов требуют передачи данных в формате JSON или XML. Если конечная точка поддерживает и требует другой формат, необходимо указать данный факт для этой точки.

Поддерживаемые значения контент-тип включают в себя:

  • application/json
  • application/xml
  • image/jpeg
  • image/png

Ответы

Ответы состоят из заголовков и тела. Тело форматируется с учетом контента-типа, указанных в запросе.

См. Словарь – Заголовки, где приведены данные о кодах ответов заголовка HTTP.

Примеры

Добавление примечания к заказу

cURL
curl -X POST \
  'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
  "text": "This is a note"
}'
Python
import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"

payload = "{\n\t\"text\": \"This is a note\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/xml"
    }

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

print(response.text)
Go
package main

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

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"

	payload := strings.NewReader("{\n\t\"text\": \"This is a note\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/xml")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
NodeJS
var request = require("request");

var options = { method: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note',
  headers: 
   { 'Content-Type': 'application/xml',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: '{\n\t"text": "This is a note"\n}' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
201 Created
{  
   "id": 1,
   "date_created": "2018-09-26T20:29:09+00:00",
   "text": "This is a note",
   "user": {  
      "id": 125039,
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@digicert.com"
   }
}

Восстановление всех примечаний к заказу

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/xml"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)
Go
package main

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

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/xml")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
NodeJS
var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note',
  headers: 
   { 'Content-Type': 'application/xml',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
200 OK
{  
   "notes": [  
      {  
         "id": 1,
         "date_created": "2018-09-26T20:29:09+00:00",
         "text": "This is a note",
         "user": {  
            "id": 125039,
            "first_name": "John",
            "last_name": "Smith",
            "email": "john.smith@digicert.com"
         }
      }
   ]
}

Удаление примечание из заказа

cURL
curl -X DELETE \
  'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note/{{note_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note/{{note_id}}"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/xml"
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)
Go
package main

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

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note/{{note_id}}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/xml")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
NodeJS
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note/{{note_id}}',
  headers: 
   { 'Content-Type': 'application/xml',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
204 No Content
// empty