Aller au contenu principal

2.2 Commande de certificat

2.2.1 Description de l’interface

Environnement de test
Environnement réelhttps://portal.racent.com/ssl/place
Méthode de requêtePOST
content-typemultipart/form-data
DescriptionCette interface est utilisée pour commander un certificat.

2.2.2 Définition des paramètres

Nom du paramètreType de paramètreObligatoireDescription
api_tokenStringYIdentifiant d’authentification. Pour générer un token, veuillez contacter le support technique de Racent.
productCodeStringYCode produit, pour obtenir le code produit (voir 2.7)
yearsIntYDurée d’achat (actuellement seules les valeurs 1, 2, 3, 4, 5 sont prises en charge), selon le produit spécifique.
refIdStringNNuméro de commande client unique fourni par le client
verificationPicFileNDocuments de vérification de secours. Utilisés pour la validation de l’organisation, formats pris en charge : .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf, taille maximale de 2 Mo.
domainVerificationPicFileNLorsque la méthode de validation du domaine est : VERIFY_DOCUMENT, cet élément est Y. Utilisé pour la validation du contrôle de domaine (DCV) (actuellement pris en charge uniquement par CFCA).
paramsStringYInformations de commande, description détaillée ci-dessous
csrStringNLorsque le paramètre est vide, un CSR sera généré pour vous et la clé privée sera enregistrée.
privateKeyStringNClé privée.
serverStringNServeur. Uniquement lié aux certificats SSL. Le paramètre du certificat SSL est Y, celui des autres types de produits est N. Si ce paramètre n’est pas nécessaire, utilisez « other » par défaut.
orgCheckIntNLa valeur est 0 ou 1. Lorsque la valeur est 1, toutes les organisations de votre compte seront recherchées en fonction des informations d'organisation que vous avez soumises. Si elles existent, les informations associées de l'organisation existante seront utilisées ; si elles n'existent pas, nous les enregistrerons comme nouvelle organisation. Lorsque la valeur est 0, les informations d'organisation ne sont pas enregistrées.
duplicateOrgCheckIntNLa valeur est 0 ou 1. Ce paramètre ne concerne actuellement que les certificats SSL Digicert. Il est utilisé pour déterminer s'il faut réutiliser les informations d'organisation et de domaine précédemment validées. Lorsque la valeur est 1, réutiliser. Lorsque la valeur est 0, créer de nouvelles informations. La valeur par défaut est 1.
needFreeIntNLa valeur est 1 ou 2. Lorsque la valeur est 1, le FQDN sera offert, et www.domain offrira également domain. Lorsque la valeur est 2, aucun domaine n'est offert.
uniqueValueStringNUniquement lié aux produits Sectigo. 1 à 20 caractères (a-z A-Z 0-9) pour que le distributeur puisse générer lui-même la valeur de validation.
dcvMethodStringNDéfinit de manière unifiée la méthode de validation du domaine pour la demande.
Doit être l’une des quatre méthodes suivantes :
EMAIL (validation par e-mail)
HTTP_CSR_HASH (validation par fichier)
CNAME_CSR_HASH (validation DNS)
HTTPS_CSR_HASH (validation par fichier https)
VERIFY_DOCUMENT (preuve de certificat de domaine, uniquement pris en charge par CFCA)
Pour CFCA, cet élément est Y.
domainInfoStringNInformations sur le domaine, uniquement liées au certificat SSL. Le paramètre du certificat SSL est Y, celui des autres types est N.
Exemple :
[
{ "dcvEmail": "admin@xxx.com",
"dcvMethod": "EMAIL",
"domainName": "www.xxx.com"
},
{
"dcvEmail": "admin@aaa.com",
"dcvMethod": "EMAIL",
"domainName": "aaa.com"
},
"dcvEmail": "admin@racent.com",
"dcvMethod": "EMAIL",
"domainName": "racent.com"
}
]
Description détaillée :
dcvMethodStringNMéthode de validation du domaine.
Doit être l’une des quatre méthodes suivantes :
EMAIL (validation par e-mail)
HTTP_CSR_HASH (validation par fichier)
CNAME_CSR_HASH (validation DNS)
HTTPS_CSR_HASH (validation par fichier HTTPS)
Lorsque le dcvMethod du niveau supérieur n’existe pas, cet élément est Y.
Lorsque le dcvMethod du niveau supérieur existe et que cet élément existe également, le dcvMethod du niveau supérieur est utilisé en priorité.
dcvEmailStringNE-mail de validation du domaine.
Lorsque cet élément est N, les valeurs par défaut sont les suivantes
racent.com : admin@racent.com
www.racent.com : admin@racent.com
*.racent.com : admin@racent.com
domainNameStringNNom de domaine
organizationInfoStringNInformations sur l’entreprise. Lors de la commande de produits nécessitant une validation d’entreprise, ce paramètre est Y. Exemple comme suit :
{
"organizationCity": "Shanghai",
"organizationName": "Une société",
"organizationMobile": "18111111111",
"organizationAddress": "Rue de Shanghai",
"organizationCountry": "CN",
"organizationPostCode": "401320"
}"
organizationCityStringNVille où se situe l’entreprise.
organizationNameStringNNom de l’entreprise.
organizationMobileStringNTéléphone de l’entreprise.
organizationAddressStringNAdresse de l'entreprise.
organizationCountryStringNPays de l'entreprise (code à deux lettres selon la norme ISO 3166-1).
organizationPostCodeStringNCode postal du lieu de l'entreprise.
organizationRegNumbeStringNNuméro d’enregistrement de l’entreprise. Pour CFCA, ce champ est Y.
idTypeStringNType de pièce d’identité de l’entreprise. Pour CFCA, ce champ est Y.
Valeurs :
TYDMZ : Code de crédit social unifié
OTHERS : Autre
AdministratorstringYInformations sur l’administrateur, le contact. Lors d’une demande de certificat de signature de code, de signature d’e-mail ou de signature de document, ce paramètre sert d’informations de demande. De plus, si csr est N, ces informations servent à générer le csr.
{
"job": "Direction générale",
"city": "Shanghai",
"email": "xx@yy.com",
"state": "Shanghai",
"mobile": "18111111111",
"address": "Shanghai",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "Une entreprise"
}"
jobStringYPoste de l’administrateur.
cityStringYVille où se trouve l’administrateur.
emailStringYAdresse e-mail de l’administrateur.
stateStringYProvince ou État où se trouve l’administrateur.
mobileStringYCoordonnées de l’administrateur.
addressStringYAdresse de contact de l’administrateur.
countryStringYPays de l’administrateur (code à deux lettres selon la norme ISO 3166-1).
lastNameStringYNom de famille de l’administrateur.
postCodeStringYCode postal de la localité de l’administrateur.
firstNameStringYPrénom de l’administrateur.
organationStringYNom de l’entreprise de l’administrateur.
idTypeStringNType de pièce d’identité. Pour CFCA, ce champ est Y.
idNumberStringNNuméro de pièce d’identité. Pour CFCA, ce champ est Y.
financestringUniquement lié aux certificats SSL.
Informations du personnel financier. Peuvent être identiques aux informations de l’administrateur. Lorsque le produit commandé n’est pas de type DV, ce paramètre est Y.
{
"job": "财务部",
"city": "上海市",
"email": "xx@yy.com",
"state": "上海市",
"mobile": "18111111111",
"address": "上海市",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "某公司"
}"
jobStringNPoste du responsable financier.
cityStringNVille du responsable financier.
emailStringNAdresse e-mail du responsable financier.
stateStringNProvince ou État du responsable financier.
mobileStringNCoordonnées du responsable financier.
addressStringNAdresse de contact du responsable financier.
countryStringNPays où se trouve le responsable financier (code à deux lettres conforme à la norme ISO 3166-1).
lastNameStringNNom de famille du responsable financier.
postCodeStringNCode postal du lieu où se trouve le responsable financier.
firstNameStringNPrénom du responsable financier.
organationStringNSociété du responsable financier.
idTypeStringNType de pièce d’identité. Pour CFCA, ce champ est Y.
Valeurs :
SFZ : carte d’identité
HZ : passeport
idNumberStringNNuméro de la pièce d’identité. Pour CFCA, ce champ est Y.
techstringNUniquement lié aux certificats SSL.
Informations du technicien. Lorsque le produit commandé n’est pas de type DV, ce paramètre est Y.
{
"job": "技术部","city": "上海市",
"email": "xx@yy.com",
"state": "上海市",
"mobile": "18111111111",
"address": "上海市",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "某公司"
}"
jobStringNPoste du technicien.
cityStringNVille où se trouve le technicien.
emailStringNAdresse e-mail du technicien.
stateStringNProvince ou État où se trouve le technicien.
mobileStringNCoordonnées du technicien.
addressStringNAdresse de contact du technicien.
countryStringNPays du technicien (code à deux lettres selon la norme ISO 3166-1).
lastNameStringNNom de famille du technicien.
postCodeStringNCode postal du lieu où se trouve le technicien.
firstNameStringNPrénom du technicien.
organationStringNSociété dans laquelle travaille le technicien.
idTypeStringNType de pièce d’identité. Pour la CFCA, cet élément est Y.
Valeurs :
SFZ : carte d’identité
HZ : passeport
idNumberStringNNuméro de pièce d’identité. Pour la CFCA, cet élément est Y.

Retour de la fonction

Nom du paramètreType du paramètreRequisDescription
codeIntYStatut de retour. Pour plus de détails, voir l’annexe 3.1
errorsObject or StringNEn cas d’erreur, informations détaillées sur l’erreur.
dataObjectNEn cas de succès, cet élément est Y. Description détaillée ci-dessous :
certIdStringNID du certificat racent. À conserver précieusement, c’est l’identifiant unique de l’instance racent.
failReasonObjectNRenvoyé lorsque Racent échoue à demander un certificat auprès de l’autorité de certification et que la raison de l’échec peut être clairement identifiée.
dataReasonsArrayNRaisons des données
keyStringNÉlément
reasonStringNRaison
sysReasonStringNRaison système
vendorIdStringNNuméro de commande CA.
vendorCertIdStringNNuméro de certificat CA.
DCVfileNameStringNNom du fichier de validation par fichier
DCVfileContentStringNContenu du fichier de validation par fichier
DCVdnsHostStringNValeur de l'hôte de validation DNS
DCVdnsValueStringNValeur de l'enregistrement de validation DNS
DCVdnsTypeStringNType d'enregistrement de validation DNS
DCVfilePathStringNChemin du fichier de validation par fichier
dcvInfoObjectNLorsque les valeurs de validation de chaque domaine dans la demande de certificat sont différentes, cet élément est Y.
Chaque entrée est de type Object, chaque objet porte le nom du domaine demandé, par exemple : racent.com. Le détail de chaque entrée est le suivant :
DCVfileNameStringNContenu du fichier de validation par fichier
DCVfileContentStringNContenu du fichier pour la validation par fichier
DCVdnsHostStringNValeur d'hôte pour la validation DNS
DCVdnsValueStringNValeur d'enregistrement pour la validation DNS
DCVdnsTypeStringNType d'enregistrement pour la validation DNS
DCVfilePathStringNChemin du fichier pour la validation par fichier