Zum Hauptinhalt springen

2.2 Zertifikat bestellen

2.2.1 Schnittstellenbeschreibung

Testumgebung
Produktivumgebunghttps://portal.racent.com/ssl/place
AnfragemethodePOST
content-typemultipart/form-data
BeschreibungDiese Schnittstelle dient zur Bestellung von Zertifikaten.

2.2.2 Parameterdefinition

ParameternameParametertypPflichtBeschreibung
api_tokenStringYIdentitätsnachweis. Zur Generierung des Tokens wenden Sie sich bitte an den technischen Support von Racent.
productCodeStringYProduktcode, Produktcode abrufen (siehe 2.7)
yearsIntYKaufzeitraum in Jahren (derzeit nur 1, 2, 3, 4, 5 unterstützt), abhängig vom konkreten Produkt.
refIdStringNEindeutige Kundenbestellnummer, die vom Kunden bereitgestellt wird
verificationPicDateiNZusätzliches Verifizierungsmaterial. Wird für die Organisationsvalidierung verwendet, unterstützt die Formate .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf, Größe maximal 2 MB.
domainVerificationPicDateiNWenn die Domain-Validierungsmethode VERIFY_DOCUMENT ist, ist dieses Feld Y. Wird für die Domain Control Validation (DCV) verwendet (derzeit wird nur CFCA unterstützt).
paramsStringYBestellinformationen, Einzelheiten siehe unten
csrStringNWenn der Parameter leer ist, wird eine CSR für Sie generiert und der private Schlüssel gespeichert.
privateKeyStringNPrivater Schlüssel.
serverStringNServer. Nur für SSL-Zertifikate relevant. Für SSL-Zertifikat-Parameter Y, für andere Produkttypen N. Wenn dieser Parameter nicht benötigt wird, verwenden Sie standardmäßig „other“.
orgCheckIntNWert ist 0 oder 1. Bei Wert 1 werden anhand der von Ihnen übermittelten Organisationsinformationen alle Organisationen unter Ihrem Konto abgerufen. Ist eine davon vorhanden, werden die zugehörigen Informationen dieser Organisation verwendet; ist keine vorhanden, speichern wir sie als neue Organisation. Bei Wert 0 werden keine Organisationsinformationen gespeichert.
duplicateOrgCheckIntNWert ist 0 oder 1. Dieser Parameter bezieht sich derzeit nur auf Digicert SSL-Zertifikate. Er dient zur Feststellung, ob zuvor validierte Organisations- und Domäneninformationen wiederverwendet werden sollen. Bei Wert 1 werden sie wiederverwendet. Bei Wert 0 werden sie neu angelegt. Standardmäßig 1.
needFreeIntNWert ist 1 oder 2. Bei Wert 1 wird die FQDN geschenkt, und gleichzeitig wird bei www.domain auch domain geschenkt. Bei Wert 2 wird nichts geschenkt.
uniqueValueStringNNur für Sectigo-Produkte relevant. 1–20 Zeichen (a–z A–Z 0–9) für die eigenständige Generierung des Verifizierungswerts durch den Distributor.
dcvMethodStringNLegt einheitlich die Verifizierungsmethode für die beantragte Domain fest.
Muss eine der folgenden vier Methoden sein:
EMAIL(E-Mail-Verifizierung)
HTTP_CSR_HASH(Dateiverifizierung)
CNAME_CSR_HASH(DNS-Verifizierung)
HTTPS_CSR_HASH(HTTPS-Dateiverifizierung)
VERIFY_DOCUMENT(Domain-Zertifikatsnachweis, nur CFCA unterstützt)
Für CFCA ist dieser Wert Y
domainInfoStringNDomaininformationen, nur für SSL-Zertifikate relevant. Für SSL-Zertifikatsparameter ist der Wert Y, für andere Typen N.
Beispiel:
[
{ "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"
}
]
Konkrete Beschreibung wie folgt:
dcvMethodStringNMethode der Domain-Validierung.
Muss eine der folgenden vier Methoden sein:
EMAIL (E-Mail-Validierung)
HTTP_CSR_HASH (Datei-Validierung)
CNAME_CSR_HASH (DNS-Validierung)
HTTPS_CSR_HASH (HTTPS-Datei-Validierung)
Wenn die übergeordnete dcvMethod nicht vorhanden ist, ist dieses Feld Y.
Wenn die übergeordnete dcvMethod vorhanden ist und dieses Feld ebenfalls vorhanden ist, wird die übergeordnete dcvMethod bevorzugt verwendet
dcvEmailStringNE-Mail für die Domain-Validierung.
Wenn dieses Feld N ist, gelten folgende Standardwerte:
racent.com : admin@racent.com
www.racent.com : admin@racent.com
*.racent.com : admin@racent.com
domainNameStringNDomainname
organizationInfoStringNUnternehmensinformationen. Wenn ein Produkt mit Unternehmensvalidierung bestellt wird, ist dieser Parameter Y. Beispiel:
{
"organizationCity": "Shanghai",
"organizationName": "Ein Unternehmen",
"organizationMobile": "18111111111",
"organizationAddress": "Straße in Shanghai",
"organizationCountry": "CN",
"organizationPostCode": "401320"
}"
organizationCityStringNStadt des Unternehmens.
organizationNameStringNName des Unternehmens.
organizationMobileStringNTelefonnummer des Unternehmens.
organizationAddressStringNFirmenadresse.
organizationCountryStringNLand der Firma (zweibuchstabiger Code gemäß ISO 3166-1-Standard).
organizationPostCodeStringNPostleitzahl des Firmenstandorts.
organizationRegNumbeStringNFirmenregistrierungsnummer. Bei CFCA ist dieses Feld Y.
idTypeStringNTyp des Firmenregistrierungsnachweises. Bei CFCA ist dieses Feld Y.
Mögliche Werte:
TYDMZ: Unified Social Credit Code
OTHERS: Sonstige
AdministratorstringYAdministratorinformationen, Kontaktperson. Bei der Beantragung von Codesignatur-, E-Mail-Signatur- und Dokumentsignaturzertifikaten dient dieser Parameter als Antragsinformation. Wenn csr außerdem N ist, werden diese Informationen zur CSR-Erzeugung verwendet.
{
"job": "Geschäftsleitung",
"city": "Shanghai",
"email": "xx@yy.com",
"state": "Shanghai",
"mobile": "18111111111",
"address": "Shanghai",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "Beispielunternehmen"
}"
jobStringYPosition des Administrators.
cityStringYStadt des Administrators.
emailStringYE-Mail-Adresse des Administrators.
stateStringYProvinz oder Bundesstaat des Administrators.
mobileStringYKontaktmöglichkeit des Administrators.
addressStringYKontaktadresse des Administrators.
countryStringYLand des Administrators (zweibuchstabiger Code gemäß ISO 3166-1).
lastNameStringYNachname des Administrators.
postCodeStringYPostleitzahl des Standorts des Administrators.
firstNameStringYName des Administrators.
organationStringYFirmenname des Administrators.
idTypeStringNAusweistyp. Bei CFCA ist dieses Feld Y.
idNumberStringNAusweisnummer. Bei CFCA ist dieses Feld Y.
financestringNur für SSL-Zertifikate relevant.
Angaben zur Finanzabteilung. Kann mit den Admin-Informationen übereinstimmen. Wenn das bestellte Produkt nicht vom Typ DV ist, ist dieser Parameter Y.
{
"job": "Finanzabteilung",
"city": "Shanghai",
"email": "xx@yy.com",
"state": "Shanghai",
"mobile": "18111111111",
"address": "Shanghai",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "Firma"
}"
jobStringNPosition des Finanzmitarbeiters.
cityStringNStadt, in der sich der Finanzmitarbeiter befindet.
emailStringNE-Mail-Adresse des Finanzmitarbeiters.
stateStringNProvinz oder Bundesland, in dem sich der Finanzmitarbeiter befindet.
mobileStringNKontakttelefonnummer des Finanzmitarbeiters.
addressStringNKontaktadresse des Finanzmitarbeiters.
countryStringNLand des Finanzmitarbeiters (zweistelliger Code gemäß ISO 3166-1).
lastNameStringNNachname des Finanzmitarbeiters.
postCodeStringNPostleitzahl des Standorts des Finanzmitarbeiters.
firstNameStringNVorname des Finanzmitarbeiters.
organationStringNDas Unternehmen, bei dem der Finanzverantwortliche tätig ist.
idTypeStringNArt des Ausweisdokuments. Bei CFCA ist dieses Feld Y.
Werte wie folgt:
SFZ: Personalausweis
HZ: Reisepass
idNumberStringNAusweisnummer. Bei CFCA ist dieses Feld Y.
techstringNNur für SSL-Zertifikate relevant.
Informationen zum Techniker. Wenn das bestellte Produkt nicht vom Typ dv ist, ist dieser Parameter Y.
{
"job": "Technikabteilung","city": "Shanghai",
"email": "xx@yy.com",
"state": "Shanghai",
"mobile": "18111111111",
"address": "Shanghai",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "Ein Unternehmen"
}"
jobStringNPosition des Technikers.
cityStringNStadt des Technikers.
emailStringNE-Mail-Adresse des Technikers.
stateStringNBundesland oder Kanton des Technikers.
mobileStringNKontaktmöglichkeit des Technikers.
addressStringNKontaktadresse des Technikers.
countryStringNLand des Technikers (zweibuchstabiger Code nach ISO 3166-1).
lastNameStringNNachname des Technikers.
postCodeStringNPostleitzahl des Standorts des Technikers.
firstNameStringNVorname des Technikers.
organationStringNUnternehmen des Technikers.
idTypeStringNDokumenttyp. Bei CFCA ist dieses Feld Y.
Mögliche Werte:
SFZ: Personalausweis
HZ: Reisepass
idNumberStringNDokumentnummer. Bei CFCA ist dieses Feld Y.

Rückgabewert der Funktion

ParameternameParametertypPflichtBeschreibung
codeIntYRückgabestatus. Details siehe Anhang 3.1
errorsObject oder StringNWenn der Rückgabestatus ein Fehler ist, enthält dieses Feld die konkreten Fehlerinformationen.
dataObjectNWenn der Rückgabestatus erfolgreich ist, ist dieses Feld Y. Details siehe unten:
certIdStringNracent-Zertifikats-ID. Bitte bewahren Sie diese sorgfältig auf, da sie das eindeutige Kennzeichen der racent-Instanz ist.
failReasonObjectNWenn die Zertifikatsbeantragung bei der CA durch Racent fehlschlägt und die Fehlerursache eindeutig ermittelt werden kann, wird dieses Feld zurückgegeben.
dataReasonsArrayNDatenursachen
keyStringNProjekt
reasonStringNUrsache
sysReasonStringNSystemursache
vendorIdStringNCA-Bestellnummer.
vendorCertIdStringNCA-Zertifikatsnummer.
DCVfileNameStringNDateiname der Dateivalidierung
DCVfileContentStringNInhalt der Dateivalidierungsdatei
DCVdnsHostStringNHostwert der DNS-Validierung
DCVdnsValueStringNEintragswert der DNS-Validierung
DCVdnsTypeStringNEintragstyp der DNS-Validierung
DCVfilePathStringNPfad der Dateivalidierungsdatei
dcvInfoObjectNWenn die Validierungswerte für jede Domain im Zertifikatsantrag unterschiedlich sind, ist dieser Wert Y.
Jedes Element ist vom Typ Object. Der Objektname jedes Elements ist die beantragte Domain, z. B. racent.com. Details zu jedem Element sind wie folgt:
DCVfileNameStringNInhalt der Dateivalidierungsdatei
DCVfileContentStringNInhalt der Datei zur Dateivalidierung
DCVdnsHostStringNHostwert der DNS-Validierung
DCVdnsValueStringNWert des DNS-Validierungseintrags
DCVdnsTypeStringNTyp des DNS-Validierungseintrags
DCVfilePathStringNDateipfad zur Dateivalidierung