Commander un certificat de signature de document

POST

https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}

Cette page décrit les produits dont le nom de groupe est document_signing (consulter le Glossaire – Identificateurs de produits).

Appelez ce point de terminaison pour envoyer une commande de certificat de signature de document en utilisant document_signing_org_1 ou document_signing_org_2 dans le paramètre document_certificate_id.

cURL

curl -X POST \
  'https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
        "server_platform": {
            "id": 21
        },
        "signature_hash": "sha256"
    },
    "cs_provisioning_method": "ship_token",
    "use_org_as_common_name": true,
    "validity_years": 2,
    "comments": "Comments for the the approver.",
    "organization": {
        "id": 334455
    },
    "container": {
        "id": 221122
    },
    "ship_info": {
        "name": "Erin Guerra",
        "addr1": "360 Taylor Street",
        "addr2": "Floor 74",
        "city": "Richmond",
        "state": "va",
        "zip": "69662",
        "country": "us",
        "method": "standard"
    },
    "subject": {
        "name": "Rene Pierce",
        "job_title": "School Counselor",
        "phone": "054-139-0798",
        "email": "rene.pierce@yahoo.com"
    },
    "csa_agreed_to": 1,
    "skip_approval": true,
    "payment_method": "balance"
}'

Python

import requests

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

payload = "{\n    \"certificate\": {\n        \"server_platform\": {\n            \"id\": 21\n        },\n        \"signature_hash\": \"sha256\"\n    },\n    \"cs_provisioning_method\": \"ship_token\",\n    \"use_org_as_common_name\": true,\n    \"validity_years\": 2,\n    \"comments\": \"Comments for the the approver.\",\n    \"organization\": {\n        \"id\": 334455\n    },\n    \"container\": {\n        \"id\": 221122\n    },\n    \"ship_info\": {\n        \"name\": \"Erin Guerra\",\n        \"addr1\": \"360 Taylor Street\",\n        \"addr2\": \"Floor 74\",\n        \"city\": \"Richmond\",\n        \"state\": \"va\",\n        \"zip\": \"69662\",\n        \"country\": \"us\",\n        \"method\": \"standard\"\n    },\n    \"subject\": {\n        \"name\": \"Rene Pierce\",\n        \"job_title\": \"School Counselor\",\n        \"phone\": \"054-139-0798\",\n        \"email\": \"rene.pierce@yahoo.com\"\n    },\n    \"csa_agreed_to\": 1,\n    \"skip_approval\": true,\n    \"payment_method\": \"balance\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)

package main

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

func main() {

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

	payload := strings.NewReader("{\n    \"certificate\": {\n        \"server_platform\": {\n            \"id\": 21\n        },\n        \"signature_hash\": \"sha256\"\n    },\n    \"cs_provisioning_method\": \"ship_token\",\n    \"use_org_as_common_name\": true,\n    \"validity_years\": 2,\n    \"comments\": \"Comments for the the approver.\",\n    \"organization\": {\n        \"id\": 334455\n    },\n    \"container\": {\n        \"id\": 221122\n    },\n    \"ship_info\": {\n        \"name\": \"Erin Guerra\",\n        \"addr1\": \"360 Taylor Street\",\n        \"addr2\": \"Floor 74\",\n        \"city\": \"Richmond\",\n        \"state\": \"va\",\n        \"zip\": \"69662\",\n        \"country\": \"us\",\n        \"method\": \"standard\"\n    },\n    \"subject\": {\n        \"name\": \"Rene Pierce\",\n        \"job_title\": \"School Counselor\",\n        \"phone\": \"054-139-0798\",\n        \"email\": \"rene.pierce@yahoo.com\"\n    },\n    \"csa_agreed_to\": 1,\n    \"skip_approval\": true,\n    \"payment_method\": \"balance\"\n}")

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

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

	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/{{document_certificate_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: { server_platform: { id: 21 }, signature_hash: 'sha256' },
     cs_provisioning_method: 'ship_token',
     use_org_as_common_name: true,
     validity_years: 2,
     comments: 'Comments for the the approver.',
     organization: { id: 334455 },
     container: { id: 221122 },
     ship_info: 
      { name: 'Erin Guerra',
        addr1: '360 Taylor Street',
        addr2: 'Floor 74',
        city: 'Richmond',
        state: 'va',
        zip: '69662',
        country: 'us',
        method: 'standard' },
     subject: 
      { name: 'Rene Pierce',
        job_title: 'School Counselor',
        phone: '054-139-0798',
        email: 'rene.pierce@yahoo.com' },
     csa_agreed_to: 1,
     skip_approval: true,
     payment_method: 'balance' },
  json: true };

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

  console.log(body);
});

201 Created (one-step approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "pending"
        }
    ]
}

201 Created (two-step approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "submitted"
        }
    ]
}

201 Created

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "approved"
        }
    ],
    "certificate_id": 113
}

Paramètres de demande

Nom	Obligatoire/facultatif	Type	Description
certificate	Obligatoire	object	Détails du certificat
.. csr	Facultatif*	string	Demande de signature de certificat (Certificate Signing Request, CSR) *Obligatoire si `cs_provisioning_method` est `email`.
.. server_platform	Facultatif	object	Type de plate-forme serveur Valeur par défaut : `-1` (autre)
.. .. id	Obligatoire	int	Identificateur de la plate-forme serveur Consultez le Glossaire — Plateformes serveurs.
.. signature_hash	Obligatoire	string	Algorithme de hachage utilisé pour signer le certificat. Valeurs autorisées : `sha256`
cs_provisioning_method	Facultatif	string	Indiquez la méthode de réception du jeton. Consultez le Glossaire — Méthodes d’approvisionnement CS
use_org_as_common_name	Facultatif	bool	Indiquez si le nom de l'organisation doit être utilisé comme nom commun sur le certificat. Valeur par défaut : `true`
validity_years	Obligatoire	int	Nombre d’années pendant lesquelles le certificat est valide Valeurs autorisées : `1`, `2`, `3`
comments	Facultatif	string	Commentaires relatifs à la commande à l’attention de l’approbateur.
organization	Obligatoire	object	Organisation à associer à la commande
.. id	Obligatoire	int	ID de l’organisation
container	Facultatif	object	Si besoin, spécifier le conteneur sous lequel la commande doit être passée.
.. id	Obligatoire	int	ID du conteneur
ship_info	Facultatif	object	Indiquez l'adresse de livraison du jeton.
.. name	Obligatoire	Chaîne
.. addr1	Obligatoire	Chaîne
.. addr2	Facultatif	Chaîne
.. city	Obligatoire	Chaîne
.. state	Obligatoire	Chaîne
.. zip	Obligatoire	Chaîne
.. country	Obligatoire	Chaîne
.. method	Obligatoire	string	Priorité d’expédition du jeton Valeurs autorisées : `standard`, `expedited` (entraîne des coûts supplémentaires)
subject	Obligatoire	object	Informations sur le sujet du certificat.
.. name	Obligatoire	string	Nom complet du sujet.
.. job_title	Obligatoire	string	Intitulé de poste du sujet.
.. phone	Obligatoire	string	Numéro de téléphone du sujet.
.. email	Obligatoire	string	Adresse électronique du sujet.
custom_fields	Facultatif*	object	Champs personnalisés en fonction du compte *Le caractère obligatoire ou facultatif de ces champs dépend des paramètres de champ personnalisé définis.
.. metadata_id	Obligatoire	int	ID de champ personnalisé
.. value	Obligatoire	string	Valeur du champ personnalisé Le type de validation des données dépend des paramètres de champ personnalisé que vous avez définis.
user_id_assignments	Facultatif	array	Liste des ID utilisateur qui peuvent gérer la commande.
skip_approval	Facultatif	bool	Spécifier si la commande peut immédiatement être envoyée pour validation et émise une fois finalisée sans passer par l’étape d’approbation. Valeur par défaut : `false`
payment_method	Facultatif	string	Indique le mode de paiement à utiliser Valeurs autorisées : `balance`, `card`, `profile` Valeur par défaut : `balance`

Paramètres de réponse

Nom	Type	Description
id	int	ID de la commande
organization	object	Conteneur destiné aux nouveaux détails de l’organisation Retourné seulement si une nouvelle organisation a été créée avec la commande.
.. id	int	ID de la nouvelle organisation
requests	array	Contient les informations relatives à la demande.
.. id	int	ID de la demande
.. status	string	Statut de la demande Valeurs possibles : `pending`, `submitted`, `approved`, `rejected`
certificate_id	int	ID du certificat Renvoyé si le statut de la demande est `approved`.

Paramètres de demande

Paramètres de réponse

À propos de