API Services

L’API DigiCert Services API è una potente API che ti consente di automatizzare i tipici processi di certificato per risparmiare tempo e semplificare la gestione dei certificati. Services API utilizza convenzioni RESTful moderne ed è semplice da usare.

Perché usarlo?

  • L'accesso a tutte le funzioni disponibili in CertCentral senza dover accedere alla piattaforma.
  • Personalizza e automatizza virtualmente qualsiasi flusso di lavoro all’interno della piattaforma di gestione certificati.
  • Crea la tua versione della piattaforma con il brand della tua organizzazione.
  • Si integra senza problemi con i tuoi strumenti esistenti.

URL base

Usa questo URL base quando crei delle richieste API:

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

La pagina di ciascun endpoint fornisce solo l’ultima parte dell’URL endpoint (ad es. /ordini). Quando crei delle richieste, accertati di anteporre l’URL base all’endpoint.

Stringhe di query URL

Alcuni endpoint utilizzano le stringhe di query URL per filtrare i risultati. Le stringhe di query URL sono anteposte all’URL endpoint usando ?, con altre stringhe di query anteposte usando &.

Questo esempio utilizza la stringa di query container_id per filtrare i risultati nel contenitore specificato. Inoltre, utilizza la stringa di query limit per visualizzare solo dieci risultati.

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

Richieste

Tutte le richieste API vengono inviate tramite gli URL RESTful usando le funzioni REST, fra cui l’autenticazione basata su intestazione e i tipi di richiesta JSON/XML.

La codifica della serie di caratteri dei dati per le richieste è UTF-8. Una richiesta ben formulata utilizza la porta 443 e ha le intestazioni agente utente e lunghezza contenuto specificate.

Metodo

DigiCert Services API utilizza questi metodi HTTP standard:

  • GET
  • POST
  • PUT
  • HEAD
  • DELETE

Corpo

La maggior parte delle richieste richiede il passaggio di dati formattati JSON o XML. Se un endpoint supporta o richiede un formato diverso, sarà annotato per tale endpoint.

I valori del tipo di contenuto supportati includono:

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

Risposte

Le risposte sono formate da intestazioni e un corpo. Il corpo è formattato in base al tipo di contenuto specificato nella richiesta.

Consulta Glossario – Intestazioni per ulteriori informazioni sui codici di risposta dell’intestazione HTTP.

Esempi

Aggiunta di una nota ad un ordine

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

Recupero di tutte le note su un ordine

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

Eliminazione di una nota su un ordine

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