2.2 Zertifikat bestellen
2.2.1 Schnittstellenbeschreibung
| Testumgebung | |
|---|---|
| Produktivumgebung | https://portal.racent.com/ssl/place |
| Anfragemethode | POST |
| content-type | multipart/form-data |
| Beschreibung | Diese Schnittstelle dient zur Bestellung von Zertifikaten. |
2.2.2 Parameterdefinition
| Parametername | Parametertyp | Pflicht | Beschreibung |
|---|---|---|---|
| api_token | String | Y | Identitätsnachweis. Zur Generierung des Tokens wenden Sie sich bitte an den technischen Support von Racent. |
| productCode | String | Y | Produktcode, Produktcode abrufen (siehe 2.7) |
| years | Int | Y | Kaufzeitraum in Jahren (derzeit nur 1, 2, 3, 4, 5 unterstützt), abhängig vom konkreten Produkt. |
| refId | String | N | Eindeutige Kundenbestellnummer, die vom Kunden bereitgestellt wird |
| verificationPic | Datei | N | Zusä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. |
| domainVerificationPic | Datei | N | Wenn 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). |
| params | String | Y | Bestellinformationen, Einzelheiten siehe unten |
| csr | String | N | Wenn der Parameter leer ist, wird eine CSR für Sie generiert und der private Schlüssel gespeichert. |
| privateKey | String | N | Privater Schlüssel. |
| server | String | N | Server. 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“. |
| orgCheck | Int | N | Wert 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. |
| duplicateOrgCheck | Int | N | Wert 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. |
| needFree | Int | N | Wert 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. |
| uniqueValue | String | N | Nur 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. |
| dcvMethod | String | N | Legt 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 |
| domainInfo | String | N | Domaininformationen, 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: |
| dcvMethod | String | N | Methode 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 |
| dcvEmail | String | N | E-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 |
| domainName | String | N | Domainname |
| organizationInfo | String | N | Unternehmensinformationen. 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" }" |
| organizationCity | String | N | Stadt des Unternehmens. |
| organizationName | String | N | Name des Unternehmens. |
| organizationMobile | String | N | Telefonnummer des Unternehmens. |
| organizationAddress | String | N | Firmenadresse. |
| organizationCountry | String | N | Land der Firma (zweibuchstabiger Code gemäß ISO 3166-1-Standard). |
| organizationPostCode | String | N | Postleitzahl des Firmenstandorts. |
| organizationRegNumbe | String | N | Firmenregistrierungsnummer. Bei CFCA ist dieses Feld Y. |
| idType | String | N | Typ des Firmenregistrierungsnachweises. Bei CFCA ist dieses Feld Y. Mögliche Werte: TYDMZ: Unified Social Credit Code OTHERS: Sonstige |
| Administrator | string | Y | Administratorinformationen, 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" }" |
| job | String | Y | Position des Administrators. |
| city | String | Y | Stadt des Administrators. |
| String | Y | E-Mail-Adresse des Administrators. | |
| state | String | Y | Provinz oder Bundesstaat des Administrators. |
| mobile | String | Y | Kontaktmöglichkeit des Administrators. |
| address | String | Y | Kontaktadresse des Administrators. |
| country | String | Y | Land des Administrators (zweibuchstabiger Code gemäß ISO 3166-1). |
| lastName | String | Y | Nachname des Administrators. |
| postCode | String | Y | Postleitzahl des Standorts des Administrators. |
| firstName | String | Y | Name des Administrators. |
| organation | String | Y | Firmenname des Administrators. |
| idType | String | N | Ausweistyp. Bei CFCA ist dieses Feld Y. |
| idNumber | String | N | Ausweisnummer. Bei CFCA ist dieses Feld Y. |
| finance | string | Nur 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" }" | |
| job | String | N | Position des Finanzmitarbeiters. |
| city | String | N | Stadt, in der sich der Finanzmitarbeiter befindet. |
| String | N | E-Mail-Adresse des Finanzmitarbeiters. | |
| state | String | N | Provinz oder Bundesland, in dem sich der Finanzmitarbeiter befindet. |
| mobile | String | N | Kontakttelefonnummer des Finanzmitarbeiters. |
| address | String | N | Kontaktadresse des Finanzmitarbeiters. |
| country | String | N | Land des Finanzmitarbeiters (zweistelliger Code gemäß ISO 3166-1). |
| lastName | String | N | Nachname des Finanzmitarbeiters. |
| postCode | String | N | Postleitzahl des Standorts des Finanzmitarbeiters. |
| firstName | String | N | Vorname des Finanzmitarbeiters. |
| organation | String | N | Das Unternehmen, bei dem der Finanzverantwortliche tätig ist. |
| idType | String | N | Art des Ausweisdokuments. Bei CFCA ist dieses Feld Y. Werte wie folgt: SFZ: Personalausweis HZ: Reisepass |
| idNumber | String | N | Ausweisnummer. Bei CFCA ist dieses Feld Y. |
| tech | string | N | Nur 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" }" |
| job | String | N | Position des Technikers. |
| city | String | N | Stadt des Technikers. |
| String | N | E-Mail-Adresse des Technikers. | |
| state | String | N | Bundesland oder Kanton des Technikers. |
| mobile | String | N | Kontaktmöglichkeit des Technikers. |
| address | String | N | Kontaktadresse des Technikers. |
| country | String | N | Land des Technikers (zweibuchstabiger Code nach ISO 3166-1). |
| lastName | String | N | Nachname des Technikers. |
| postCode | String | N | Postleitzahl des Standorts des Technikers. |
| firstName | String | N | Vorname des Technikers. |
| organation | String | N | Unternehmen des Technikers. |
| idType | String | N | Dokumenttyp. Bei CFCA ist dieses Feld Y. Mögliche Werte: SFZ: Personalausweis HZ: Reisepass |
| idNumber | String | N | Dokumentnummer. Bei CFCA ist dieses Feld Y. |
Rückgabewert der Funktion
| Parametername | Parametertyp | Pflicht | Beschreibung |
|---|---|---|---|
| code | Int | Y | Rückgabestatus. Details siehe Anhang 3.1 |
| errors | Object oder String | N | Wenn der Rückgabestatus ein Fehler ist, enthält dieses Feld die konkreten Fehlerinformationen. |
| data | Object | N | Wenn der Rückgabestatus erfolgreich ist, ist dieses Feld Y. Details siehe unten: |
| certId | String | N | racent-Zertifikats-ID. Bitte bewahren Sie diese sorgfältig auf, da sie das eindeutige Kennzeichen der racent-Instanz ist. |
| failReason | Object | N | Wenn die Zertifikatsbeantragung bei der CA durch Racent fehlschlägt und die Fehlerursache eindeutig ermittelt werden kann, wird dieses Feld zurückgegeben. |
| dataReasons | Array | N | Datenursachen |
| key | String | N | Projekt |
| reason | String | N | Ursache |
| sysReason | String | N | Systemursache |
| vendorId | String | N | CA-Bestellnummer. |
| vendorCertId | String | N | CA-Zertifikatsnummer. |
| DCVfileName | String | N | Dateiname der Dateivalidierung |
| DCVfileContent | String | N | Inhalt der Dateivalidierungsdatei |
| DCVdnsHost | String | N | Hostwert der DNS-Validierung |
| DCVdnsValue | String | N | Eintragswert der DNS-Validierung |
| DCVdnsType | String | N | Eintragstyp der DNS-Validierung |
| DCVfilePath | String | N | Pfad der Dateivalidierungsdatei |
| dcvInfo | Object | N | Wenn 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: |
| DCVfileName | String | N | Inhalt der Dateivalidierungsdatei |
| DCVfileContent | String | N | Inhalt der Datei zur Dateivalidierung |
| DCVdnsHost | String | N | Hostwert der DNS-Validierung |
| DCVdnsValue | String | N | Wert des DNS-Validierungseintrags |
| DCVdnsType | String | N | Typ des DNS-Validierungseintrags |
| DCVfilePath | String | N | Dateipfad zur Dateivalidierung |