Services API

Die DigiCert Services-API ist eine leistungsfähige API, die es Ihnen erlaubt, typische Zertifikatsprozesse zu automatisieren, um Zeit zu sparen und die Zertifikatsverwaltung zu optimieren. Die Services-API verwendet moderne RESTful-Konventionen und ist einfach zu handhaben.

Warum sie verwenden?

  • Sie greifen auf alle verfügbaren Funktionen in CertCentral ohne Anmeldung bei der Plattform zu.
  • Sie können praktisch jeden Workflow innerhalb der Zertifikatsverwaltungsplattform anpassen und automatisieren.
  • Sie erstellen Ihre eigene Version der Plattform mit dem Branding Ihrer Organisation.
  • Nahtlose Integration mit Ihren vorhandenen Tools.

Basis-URL

Verwenden Sie diese Basis-URL zum Erstellen von API-Anfragen:

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

Jede Endpunktseite stellt nur den letzten Teil der Endpunkt-URL dar (z. B. /Aufträge). Achten Sie darauf, die Basis-URL dem Endpunkt beim Erstellen von Anfragen voranzustellen.

URL-Abfragezeichenfolgen

Einige Endpunkte verwenden URL-Abfragezeichenfolgen, um Ergebnisse zu filtern. URL-Abfragezeichenfolgen werden der Endpunkt-URL mithilfe von ?, und zusätzlichen mithilfe von & angehängten Abfragezeichenfolgen angehängt.

Dieses Beispiel verwendet die container_id-Abfragezeichenfolge, um Ergebnisse in den angegebenen Container zu filtern. Außerdem verwendet es die limit-Abfragezeichenfolge, sodass nur zehn Ergebnisse zurückgegeben werden.

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

Anforderungen

Alle API-Anfragen werden über RESTful-URLs mithilfe von REST-Funktionen, einschließlich headerbasierter Authentifizierung und JSON/XML-Anfragetypen übermittelt.

Die Zeichensatzkodierung für Zugriffe ist UTF-8. Ein gut gestalteter Antrag verwendet Port 443 und hat die Benutzeragenten- und Content-Längen-Header angegeben.

Methode

Die DigiCert Services-API verwendet diese Standard-HTTP-Methoden:

  • GET
  • POST
  • PUT
  • HEAD
  • DELETE

Text

Die meisten Anfragen erfordern die Weitergabe entweder formatierter JSON- oder XML-Daten. Falls ein Endpunkt ein anderes Format unterstützt oder erfordert, wird für diesen Endpunkt darauf hingewiesen.

Zu den unterstützten Content-Typ-Werten gehören:

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

Antworten

Antworten bestehen von Kopf und Text. Der Text ist auf Basis des im Antrag angegebenen Contenttyps formatiert.

Siehe Glossar – Header, um Informationen über HTTP-Header-Antwortcodes zu erhalten.

Beispiele

Hinzufügen einer Anmerkung zu einem Auftrag

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"
   }
}

Abrufen aller Anmerkungen zu einem Auftrag

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"
         }
      }
   ]
}

Löschen einer Anmerkung zu einem Auftrag

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