URL und Authentifizierung
Webservice URL
https://soap.epnic.net (OT&E: soap.ote.epnic.net)
WSDL URL
https://soap.epnic.net/cert_order/?wsdl
Authentifizierung
Um Ihre Anfrage an das System zu authentifizieren, verwenden sie bitte den Benutzernamen und das Passwort, das Sie auch zur Anmeldung an Ihrem EPAG-Kundenaccount verwenden.
Abkürzungen und Begriffe
SSL
Die Abkürzung SSL steht für Secure Sockets Layer und ist ein Protokoll zur Verschlüsselung des Datenverkehrs auf TCP/IP-Ebene.
CSR
Die Abkürzung CSR steht für „Certificate Signing Request“ und bedeutet auf deutsch in etwa „Zertifikat-Signieranforderung“. Das CSR ist eine Textzeichenfolge, die mit Hilfe einer SSL-Software für den zu zertifizierenden Domain Namen erzeugt wird. Erst nach Vorlage eines CSRs kann ein digitales Zertifikat bei der Zertifizierungsstelle (z. B. Thawte oder Symantec) erstellt werden.
WSDL
Die Web Services Description Language (WSDL) ist eine plattform-, programmiersprachen- und protokollunabhängige Beschreibungssprache für Netzwerkdienste (Webservices) zum Austausch von Nachrichten auf Basis von XML.
Einführung
Die hier dokumentierte Schnittstelle (API) dient zur automatisierten Bestellung und Verlängerung von SSL-Zertifikaten. Die Schnittstelle wird als Webservice auf SOAP-Basis bereitgestellt und ermöglicht eine Automatisierung der SSL-Auftragsverarbeitung auf Kundenseite.
Zur Erleichterung der Implementierung stellt die API einen Test-Modus bereit, in dem Aufträge nur validiert, aber nicht weiterverarbeitet werden. Dadurch können sie die Schnittstelle in ihr System integrieren und testen, ohne reale Bestellungen zu tätigen. Welcher Parameter dafür nötig ist, erfahren sie im folgenden Kapitel.
Sollten noch Fragen offen sein, beachten sie bitte auch unsere FAQ zu dem Thema Zertifikate unter http://www.epag.de/de/certs-faq.
Funktionen
Die API stellt derzeit die folgenden Funktionen zur Verfügung:
parseCSR
Prüfen und Auslesen eines CSR.
certOrder
Bestellung eines SSL-Zertifikats.
getOrders
Liefert eine Liste aller Bestellungen.
getOrderDetails
Abrufen von Detailinformationen zu einer Bestellung.
getEvents
Liefert Informationen (Ereignisse) zum Verlauf eines Bestellvorgangs.
acknowledgeEvent
Bestätigt, dass ein bestimmtes Ereignis zur Kenntnis genommen wurde.
resendApproverEMail
Erneutes Zusenden einer E-Mail für die Bestätigungsanfrage.
changeApproverEMail
Ändern der „Approver“ E-Mail-Adresse während eines Bestellvorgangs.
cancelOrder
Bricht einen laufenden Bestellvorgang ab.
Bestellablauf
Mit der Funktion parseCSR kann bereits vor Absenden einer Bestellung geprüft werden, ob das vorhandene CSR gültig ist und welche Daten darin enthalten sind.
Die Übermittlung einer SSL-Bestellung erfolgt mit der Funktion certOrder. Diese dient zur Übergabe aller für das Zertifikat benötigten Daten an EPAG. EPAG prüft die übergebenen Daten und liefert entsprechende Fehlermeldungen oder im Erfolgsfall eine Auftragsnummer zurück. Danach wird der Auftrag von EPAG bearbeitet und an die Zertifizierungsstelle übergeben.
Mit der Funktion getOrders kann eine vollständige oder gefilterte Liste aller Bestellungen abgerufen werden. Der Status einer bestimmten Bestellung kann über getOrderDetails abgerufen werden. Die Funktion getEvents liefert Meldungen zurück, für welche Bestellungen eine Änderung des Bearbeitungsstatus eingetreten ist. Wenn eine solche Meldung vom Nutzer gelesen oder bearbeitet wurde, kann sie mit acknowledgeEvent als gelesen markiert werden und wird dann beim nächsten Abruf mit getEvents nicht mehr ausgegeben.
Die Funktion resendApproverEMail erlaubt den erneuten Versand der Bestätigungsmail im Zuge des Bereitstellungsvorgangs eines Zertifikates. Mit changeApproverEMail kann der Adressat dieser Mail geändert werden.
Der Abbruch einer laufenden Bestellung ist mit cancelOrder möglich.
Bestellcodes
Symantec
Secure Site
SecureSite
Symantec
Secure Site mit EV
SecureSiteEV
Symantec
Secure Site Pro
SecureSitePro
Symantec
Secure Site Pro mit EV
SecureSiteProEV
Symantec
Code Signing Zertifikat
VeriSignCSC
Symantec
Trust Seal
TrustSealOrg
Thawte
SSL123
SSL123
Thawte
SSL Webserver
SSLWebServer
Thawte
SSL Webserver mit SAN
SSLWebServerSAN
Thawte
SSL Webserver mit Wildcard
SSLWebServerWC
Thawte
Code Signing Zertifikat
ThawteCSC
Thawte
SSL Webserver mit EV
SSLWebServerEV
Thawte
SSL Webserver mit EV & SAN
SSLWebServerEVSAN
GeoTrust
QuickSSL Premium
QuickSSLPremium
GeoTrust
True BusinessID
TrueBizID
GeoTrust
True BusinessID Wildcard
TrueBizIDWC
GeoTrust
True BusinessID mit SAN
TrueBizIDSAN
GeoTrust
True BusinessID mit EV
TrueBizIDEV
GeoTrust
True BusinessID mit EV & SAN
TrueBizIDEVSAN
RapidSSL
RapidSSL-Zertifikat
RapidSSL
RapidSSL
RapidSSL-Wildcard-Zertifikat
RapidSSLWC
GlobeSSL
GlobeSSL Standard-Zertifikat
GlobeSSL
Bestellstatus-/Event-Codes
Eine Bestellung durchläuft in der Regel mehrere Prozesse. Der Bestellstatus bezeichnet dabei den aktuellen Zustand der Bestellung, während das Event über die Ereignisse im Zusammenhang mit der Bestellung informiert. Die folgende Liste enthält die möglichen Status- sowie Event-Codes zu einer Bestellung:
Bestellstatus- und Event-Codes
0
0
Bestellung aufgenommen.
Bestellung wurde aufgenommen.
1
1
Bestellung wird bearbeitet.
Bestellvorgang gestartet.
10
Bestellung wird manuell bearbeitet.
20
Fehler während Bestellprozess.
30
Zertifikat wurde ausgestellt.
80
Stornierung wurde vermerkt.
97
97
Bestellung storniert.
Bestellung wurde storniert.
98
98
Bestellung aufgrund Fehler abgebrochen.
Bestellung aufgrund von Fehlern abgebrochen.
99
99
Bestellung erfolgreich durchgeführt.
Bestellung erfolgreich durchgeführt.
Fehlercodes
Folgende Fehlercodes werden im Falle eines Fehlers für die Fehlerbeschreibung verwendet.
VAL001
Datenfeld nicht vorhanden.
VAL100
Datenfeld besitzt keinen Inhalt.
VAL101
Ungültiger Datentyp.
VAL102
Ungültiger Dateninhalt.
VAL103
Authentifizierung fehlgeschlagen.
VAL104
Zugriff auf Webservice verweigert (fehlende Zugriffsrechte).
VAL105
Zugriff auf Webservice verweigert (keine SSL-Verbindung).
VAL200
CSR-Daten ungültig.
VAL201
CSR: Ungültiger Ländercode.
VAL202
CSR: Fehlende Daten.
VAL203
CSR: commonName[CN] ist ungültig.
VAL204
CSR: Ungültige „BEGIN“ oder „END“-Zeichenfolge.
VAL210
CSR: Unzureichende Schlüssellänge.
VAL300
E-Mail Adresse besitzt kein gültiges Format.
VAL301
„Wildcard“-Option nicht verfügbar.
VAL302
Ungültige Zertifikat-Laufzeit.
VAL303
Domain-Name besitzt kein gültiges Format.
VAL304
„Code-Signing“-Option ungültig.
VAL305
Datum oder Zeitraum ungültig.
VAL306
Domainname (SAN) darf nicht länger als 64 Zeichen sein.
VAL307
Anzahl der Domainnamen für SAN-Erweiterung nicht zulässig.
VAL308
Domainname (SAN) muss eine Unter-Domain der Second-Level-Domain des Host-Namens sein.
VAL309
Domainnamen (SAN) müssen eindeutig sein. Doppelte Einträge sind nicht zulässig.
DBA001
Datenbankfehler.
ORD001
Bestellung wurde bereits durchgeführt.
ORD002
Bestellprozess abgebrochen.
ORD003
Bestellung nicht im System vorhanden.
ORD004
E-Mail Adresse für die Bestätigungsanfrage ungültig.
ORD005
Ereignis (Event) nicht im System vorhanden.
ORD006
Aktion bei dem aktuellen Status der Bestellung nicht möglich/zulässig.
ORD007
Unzureichende Deckung auf Guthabenkonto.
GEO001
Verbindung zu Geo Trust Schnittstelle konnte nicht hergestellt werden.
GEO002
Geo Trust API Fehler.
GEO003
Geo Trust API Warnung.
GEO004
Geo Trust API Unbekannter Fehlercode.
GEO005
Geo Trust API Exception.
GLB001
GlobeSSL API Fehler.
UNK001
Unbekannter oder unbehandelter Fehler.
parseCSR
Diese Funktion dient zur Prüfung und Auswertung eines Certificate Signing Request (CSR).
Eingabeparameter
parseCSR Eingabeparameter:
auth
ja
certAuth
Enthält die Daten zur Authentifizierung bei EPAG.
csr
ja
String
Certificate Signing Request-String.
product
ja
String
Bestellcode des Zertifikats.
Siehe "Bestellbare Zertifikate"
Datentyp certAuth:
username
ja
String
Benutzername des EPAG-Accounts.
password
ja
String
Passwort des EPAG-Accounts.
parseCSR Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
certCSRInfo
Enthält die Ergebnisdaten einer erfolgreichen Bearbeitung
(Die Rückgabe dieses Parameters erfolgt nur, wenn das CSR erfolgreich validiert werden kann).
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur, wenn
Fehler aufgetreten sind).
Datentyp certCSRInfo:
countryName
String
Ländercode.
stateOrProvinceName
String
Namen des Bundeslandes, Bundesstaates oder der Provinz.
localityName
String
Namen der Stadt.
organizationName
String
Name des Unternehmens.
organizationalUnitName
String
Name der Abteilung.
commonName
String
Domainname.
emailAddress
String
E-Mail-Adresse des administrativen Kontakts.
Datentyp certError:
Code
String
Fehlercode.
Description
String
Kurze Fehlerbeschreibung.
Parameters
String
Liste/Array mit zusätzlichen Informationen (nur bei bestimmten Fehlern vorhanden).
SOAP Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:parseCSR>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<csr>?</csr>
<product>?</product>
</body>
</ns1:parseCSR>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:parseCSRResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result> <-- if resultCount greater 0 -->
<countryName>?</countryName>
<stateOrProvinceName>?</stateOrProvinceName>
<localityName>?</localityName>
<organizationName>?</organizationName>
<commonName>?</commonName>
</result>
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:parseCSRResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>certOrder
Diese Funktion dient zur verbindlichen Beauftragung von SSL-Zertifikaten über die SOAP-Schnittstelle. Die folgende Tabelle enthält eine Übersicht über die Funktionsparameter und wie diese für die verfügbaren Zertifikate zu verwenden sind.
Eingabeparameter
certOrder Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR"
Enthält die Daten zur Anmeldung bei EPAG.
orderData
ja
certOrderData
Enthält die Bestelldaten für das Zertifikat.
adminContact
ja
certAdminContact
Enthält die Kontaktdaten für den administrativen Kontakt.
techContact
ja
certTechContact
Enthält die Kontaktdaten für den technischen Kontakt.
testOrder
optional
Boolean
Gibt an, ob die Anfrage im Test-Modus gestellt werden soll. Dadurch werden keine kostenpflichtigen Aufträge erzeugt.
Datentyp certOrderData:
product
ja
String
Bestellcode des Zertifikats.
Siehe "Bestellbare Zertifikate"
orderType
ja
String
Gibt an, ob ein Zertifikat verlängert oder neu registriert wird.
Register/
Renew
period
ja
String
Zeitraum (in Jahren) für den ein Zertifikat verlängert oder registriert wird.
contactEmail
ja
String
E-Mail Adresse des Rechnungsempfängers und Kontakt für die Bestellabwicklung über EPAG (wird nicht von der Zertifizierungsstelle kontaktiert).
gültige E-Mail-Adresse
csr
siehe Tabelle
String
Certificate Signing Request
(Bei Wildcard-Zertifikaten bitte auf Domain Namen in der Form *.sld.tld achten).
hostName
siehe Tabelle
String
Domainname (für Trust Seal Prüfung oder Code Signing Zertifikate).
dnsNames
siehe Tabelle
String
Zusätzliche Host-Namen (komma separiert) für SAN-Erweiterung.
Z.B. www.name1.de,www.name2.de
webserverType
siehe Tabelle
String
Bezeichnung der Software die auf dem Server verwendet wird.
MSIIS
Other
codeSigningType
siehe Tabelle
String
Typ-Bezeichnung für Code-Signing-Zertifikate.
Apple, JavaSoft,
MSAuthentiCode
VBA, AdobeAir
approverEmail
siehe Tabelle
String
E-Mail Adresse, an die die Bestätigungsanfrage des jeweiligen Auftrags verschickt wird
(wird nur von der Zertifizierungsstelle kontaktiert).
E-Mail-Adressen im folgenden Format werden akzeptiert:
info@<Ihre Domain>
admin@<Ihre Domain>
administrator@<Ihre Domain>
hostmaster@<Ihre Domain>
root@<Ihre Domain>
webmaster@<Ihre Domain>
postmaster@<Ihre Domain>
Datentyp certAdminContact:
firstName
siehe Tabelle
String
Vorname des Admin-Kontakts.
lastName
siehe Tabelle
String
Nachname des Admin-Kontakts.
Position
siehe Tabelle
String
Funktionsbezeichnung/
Position des Admin-Kontakts.
organization
siehe Tabelle
String
Firmenname des Admin-Kontakts.
country
siehe Tabelle
String
Ländercode für den Admin-Kontakt.
z.B. DE
state
siehe Tabelle
String
Name der Region / des Bundeslandes für den Admin-Kontakt.
postalCode
siehe Tabelle
String
Postleitzahl des Admin-Kontakts.
city
siehe Tabelle
String
Städtename für den Admin-Kontakt.
street
siehe Tabelle
String
Straße und Hausnummer des Admin-Kontakts.
phone
siehe Tabelle
String
Telefonnummer des Admin-Kontakts.
fax
siehe Tabelle
String
Faxnummer des Admin-Kontakts.
siehe Tabelle
String
E-Mail-Adresse des Admin-Kontakts.
gültige E-Mail-Adresse
Datentyp certTechContact:
firstName
siehe Tabelle
String
Vorname des Tech-Kontakts.
lastName
siehe Tabelle
String
Nachname des Tech-Kontakts.
position
siehe Tabelle
String
Funktionsbezeichnung/
Position des Tech-Kontakts.
organization
siehe Tabelle
String
Firmenname des Tech-Kontakts.
country
siehe Tabelle
String
Ländercode für den Tech-Kontakt.
z.B. DE
state
siehe Tabelle
String
Name der Region / des Bundeslandes für den Tech-Kontakt.
postalCode
siehe Tabelle
String
Postleitzahl des Tech-Kontakts.
city
siehe Tabelle
String
Städtename für den Tech-Kontakt.
street
siehe Tabelle
String
Straße und Hausnummer des Tech-Kontakts.
phone
siehe Tabelle
String
Telefonnummer des Tech-Kontakts.
fax
siehe Tabelle
String
Faxnummer des Tech-Kontakts.
siehe Tabelle
String
E-Mail-Adresse des Tech-Kontakts.
gültige E-Mail-Adresse
Rückgabeparameter
certOrder Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
certOrderResult
Enthält die Ergebnisdaten einer erfolgreichen Bearbeitung. Die Rückgabe dieses Parameters erfolgt nur, wenn der Auftrag erfolgreich angenommen werden kann.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur, wenn
Fehler aufgetreten sind).
Datentyp certOrderResult:
orderId
String
Order-ID (wird später zur Statusabfrage der Bestellung benötigt). Bitte beachten Sie, dass bei Testbestellungen keine Order-ID erzeugt wird.
description
String
Beschreibt das Ergebnis des Bestellvorgangs in einem kurzen Text.
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:certOrder>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<orderData> <!-- see description -->
<product>?</product>
<orderType>?</orderType>
<period>?</period>
<contactEmail></contactEmail>
<csr>?</csr>
<hostName>?</hostName>
<dnsNames>?</dnsNames>
<webserverType>?</webserverType>
<codeSigningType>?</codeSigningType>
<approverEmail>?</approverEmail>
</orderData>
<adminContact> <!-- see description -->
<firstName>?</firstName>
<lastName>?</lastName>
<position>?</position>
<organization>?</organization>
<country>?</country>
<state>?</state>
<postalCode>?</postalCode>
<city>?</city>
<street>?</street>
<phone>?</phone>
<fax>?</fax>
<email>?</email>
</adminContact>
<techContact> <!-- see description -->
<firstName>?</firstName>
<lastName>?</lastName>
<position>?</position>
<organization>?</organization>
<country>?</country>
<state>?</state>
<postalCode>?</postalCode>
<city>?</city>
<street>?</street>
<phone>?</phone>
<fax>?</fax>
<email>?</email>
</techContact>
<testSystem>?</testSystem> <!-- Optional -->
</body>
</ns1:certOrder>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-EvNV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:certOrderResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result> <-- if resultCount greater 0 -->
<orderId>?</orderId>
<description>?</description>
</result>
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:certOrderResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>getOrders
Diese Funktion liefert eine Liste aller Zertifikats-Aufträge. Die Ausgabe kann nach bestimmten Kriterien gefiltert und sortiert werden. Dabei sind mehrere Kriterien in Kombination nutzbar.
Eingabeparameter
getOrders Eingabeparameter:
auth
ja
certAuth. Siehe 3.1 parseCSR.
Enthält die Daten zur Anmeldung bei EPAG.
filter
optional
certGetOrdersFilter
Enthält die Kriterien, nach denen die Ausgabe gefiltert werden soll.
sort
optional
certGetOrdersSort
Enthält Angaben zur Sortierung der ausgegebenen Daten.
Datentyp certGetOrdersFilter:
dateFrom
DateTime
Es werden nur Bestellungen ab dem angegebenen Datum gelesen.
ISO 8601 Datum (z.B.
2010-01-01T08:00:00-02_00)
dateTo
DateTime
Es werden nur Bestellungen bis zu dem angegebenen Datum gelesen.
ISO 8601 Datum (z.B.
2010-01-01T08:00:00-02_00)
statusCode
String
Es werden nur Bestellungen im angegebenen Status zurückgegeben (wie nebenstehend angegeben).
Siehe "Bestellstatus-/Event-Codes"
product
String
Es werden nur Bestellungen mit dem angegebenen Bestellcode (Zertifikatstyp) zurückgegeben.
Siehe "Bestellbare Zertifikate"
orderType
String
Es werden nur Bestellungen mit dem angegebenen Auftragstyp zurückgegeben.
Register
Renew
hostName
String
Es werden nur Bestellungen zu der angegebenen Domain zurückgegeben.
Datentyp certGetOrdersSort:
sortBy
String
Feldname nach dem sortiert werden soll.
statusCode
product
orderDate
nextRenewal
orderType
hostName
sortOrder
String
Art der Sortierung.
ASC
DESC
Rückgabeparameter
getOrders Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
certGetOrdersResult
Ergebnisliste.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur, wenn
Fehler aufgetreten sind).
Datentyp certGetOrdersResult:
orderId
String
Zugehörige Bestellnummer.
orderDate
DateTime
Datum der jeweiligen Bestellung.
ISO 8601 Datum
nextRenewal
DateTime
Ablaufdatum bzw. Datum an dem
das Zertifikat verlängert werden muss.
ISO 8601 Datum
product
String
Bestellcode.
Siehe "Bestellbare Zertifikate"
orderType
String
Auftragstyp.
hostName
String
Eingetragener Domain Name.
statusCode
String
Bestellstatus Code.
Siehe "Bestellstatus-/Event-Codes"
statusDesc
String
Kurze Status-Beschreibung.
vendorId
String
Interne Id des Ausstellers
(certificate authority)
Hinweis: Die ID wird erst im Verlauf der Bestellung vergeben.
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:getOrders>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<filter> <!-- optional -->
<dateFrom>?</dateFrom>
<dateTo>?</dateTo>
<statusCode>?</statusCode>
<product>?</product>
<orderType>?</orderType>
<hostName>?</hostName>
</filter>
<sort> <!-- optional -->
<sortBy>?</sortBy>
<sortOrder>?</sortOrder>
</sort>
</body>
</ns1:getOrders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:getOrdersResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result> <-- if resultCount greater 0 -->
<orderId>?</orderId>
<orderDate>?</orderDate>
<nextRenewal>?</nextRenewal>
<product>?</product>
<orderType>?</orderType>
<hostName>?</hostName>
<statusCode>?</statusCode>
<statusDesc>?</statusDesc>
<vendorId>?</vendorId> <!-- filled during order process -->
</result>
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:getOrdersResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>getOrderDetails
Liefert Detail-Informationen zu einer bestimmten Bestellung.
Eingabeparameter
getOrderDetails Eingabeparameter:
auth
Ja
certAuth. Siehe "parseCSR".
Enthält die Daten zur Anmeldung bei EPAG.
orderId
Ja
String
Jeweilige Bestellnummer.
Rückgabeparameter
getOrderDetails Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
certOrderDetails
Daten zur Bestellung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur, wenn
Fehler aufgetreten sind).
Datentyp certOrderDetails:
orderData
certOrderData. Siehe "certOrder".
Enthält die Bestelldaten für das Zertifikat.
adminContact
certAdminContact. Siehe "certOrder".
Enthält die Kontaktdaten für den administrativen Kontakt.
techContact
certTechContact. Siehe "certOrder".
Enthält die Kontaktdaten für den technischen Kontakt.
orderDate
DateTime
Datum der Bestellung.
ISO 8601 Datum
statusCode
String
Bestellstatus-Code.
Siehe "Bestellstatus-/Event-Codes"
statusDesc
String
Kurze Status-Beschreibung.
certificate
String
Daten des Zertifikats (nur gefüllt sofern Bestellung abgeschlossen wurde).
vendorId
String
Interne Id des Ausstellers (certificate authority).
Hinweis: Die ID wird erst im Verlauf der Bestellung vergeben.
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:getOrderDetails>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<orderId>?</orderId>
</body>
</ns1:getOrderDetails>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:getOrderDetailsResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result> <-- if resultCount greater 0 -->
<orderData>
<product>?</product>
<orderType>?</orderType>
<period>?</period>
<contactEmail></contactEmail>
<csr>?</csr>
<hostName>?</hostName>
<dnsNames>?</dnsNames>
<webserverType>?</webserverType>
<codeSigningType>?</codeSigningType>
<approverEmail>?</approverEmail>
</orderData>
<adminContact>
<firstName>?</firstName>
<lastName>?</lastName>
<position>?</position>
<organization>?</organization>
<country>?</country>
<state>?</state>
<postalCode>?</postalCode>
<city>?</city>
<street>?</street>
<phone>?</phone>
<fax>?</fax>
<email>?</email>
</adminContact>
<techContact>
<firstName>?</firstName>
<lastName>?</lastName>
<position>?</position>
<organization>?</organization>
<country>?</country>
<state>?</state>
<postalCode>?</postalCode>
<city>?</city>
<street>?</street>
<phone>?</phone>
<fax>?</fax>
<email>?</email>
</techContact>
<orderDate>?</orderDate>
<statusCode>?</statusCode>
<statusDesc>?</statusDesc>
<certificate>?</certificate> <!-- filled if order completed -->
<vendorId>?</vendorId> <!-- filled during order process -->
</result>
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:getOrderDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>getEvents
Über diese Funktion lassen sich alle Ereignisse (Events) zum Verlauf eines Bestellvorgangs abrufen.
Eingabeparameter
getEvents Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR".
Enthält die Daten zur Anmeldung bei EPAG.
filter
optional
certGetEventsFilter
Enthält die Kriterien, nach denen die Ausgabe gefiltert werden soll.
Datentyp certGetEventsFilter:
orderId
optional
String
Es werden nur Ereignisse zu der angegebenen Bestell-nummer gelesen.
dateFrom
optional
DateTime
Es werden nur Ereignisse ab dem angegebenen Datum gelesen.
ISO 8601 Datum (z.B.
2010-01-01T08:00:00-02_00)
dateTo
optional
DateTime
Es werden nur Ereignisse bis zu dem angegebenen Datum gelesen.
ISO 8601 Datum (z.B.
2010-01-01T08:00:00-02_00)
acknowledged
optional
Boolean
Indikator ob bestätigte oder
unbestätigte Ereignisse gelesen werden sollen.
true = nur bestätigte Ereignisse lesen.
false = nur unbestätigte Ereignisse lesen.
Rückgabeparameter
getEvents Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
certGetEventsResult
Enthält die Ergebnisdaten.
Die Rückgabe dieses Parameters erfolgt nur bei erfolgreicher Ausführung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur, wenn Fehler aufgetreten sind).
Datentyp certGetEventsResult:
orderId
String
Bestellung auf die sich das Ereignis bezieht.
eventId
String
Eindeutige Identifikationsnummer des Ereignisses.
eventCode
String
Ereignis-Code.
Siehe "Bestellstatus-/Event-Codes"
eventMsg
String
Kurze Beschreibung des Ereignisses.
eventDate
DateTime
Datum und Uhrzeit des Ereignisses.
ISO 8601 Datum
acknowledged
Boolean
Indikator ob Ereignis bereits zur Kenntnis genommen wurde.
errorCount
Integer
Anzahl der Fehlermeldungen die im Zusammenhang mit dem jeweiligen Ereignis stehen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen die im Zusammenhang
mit dem Ereignis stehen.
(Die Rückgabe dieses Parameters erfolgt nur, wenn Fehler aufgetreten sind).
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:getEvents>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<filter> <-- all optional -->
<orderId>?</orderId>
<dateFrom>?</dateFrom>
<dateTo>?</dateTo>
<acknowledged>?</acknowledged>
</filter>
</body>
</ns1:getEvents>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:getEventsResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result> <-- if resultCount greater 0 -->
<orderId>?</orderId>
<eventId>?</eventId>
<eventCode>?</eventCode>
<eventMsg>?</eventMsg>
<eventDate>?</eventDate>
<acknowledged>?</acknowledged>
<errorCount>?</errorCount>
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</result>
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:getEventsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>acknowledgeEvent
Wenn ein bestimmtes Ereignis zur Kenntnis genommen wurde, so kann dies über die Funktion
acknowledgeEvent bestätigt werden.
Eingabeparameter
acknowledgeEvent Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR"
Enthält die Daten zur Anmeldung bei EPAG.
eventId
ja
String
Eindeutige Identifikationsnummer des Ereignisses.
Rückgabeparameter
acknowledgeEvent Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
String
Kurze Erfolgsmeldung.
Die Rückgabe dieses Parameters erfolgt nur bei erfolgreicher Ausführung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur wenn Fehler aufgetreten sind).
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:acknowledgeEvent>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<eventId>?</eventId>
</body>
</ns1:acknowledgeEvents>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:acknowledgeEventResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result>?</result> <-- if resultCount greater 0 -->
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:acknowledgeEventResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>resendApproverEMail
Über diese Funktion kann eine erneute E-Mail zur Bestätigungsanfrage gesendet werden.
Achtung:
Diese Funktion steht für GlobeSSL-Zertifkate nicht zur Verfügung.
Eingabeparameter
resendApproverEMail Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR"
Enthält die Daten zur Anmeldung bei EPAG.
orderId
ja
String
Eindeutige Identifikationsnummer des Ereignisses.
Rückgabeparameter
resendApproverEMail Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
String
Kurze Erfolgsmeldung.
Die Rückgabe dieses Parameters erfolgt nur bei erfolgreicher Ausführung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur wenn Fehler aufgetreten sind).
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:acknowledgeEvent>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<eventId>?</eventId>
</body>
</ns1:acknowledgeEvents>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:acknowledgeEventResponse>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result>?</result> <-- if resultCount greater 0 -->
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:acknowledgeEventResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
changeApproverEMail
Über diese Funktion kann während des Bestellvorgangs die E-Mail-Adresse für Bestätigungsanfragen geändert werden.
Achtung:
Diese Funktion steht für GlobeSSL-Zertifkate nicht zur Verfügung.
Eingabeparameter
changeApproverEMail Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR"
Enthält die Daten zur Anmeldung bei EPAG.
orderId
ja
String
Zugehörige Bestellnummer.
ja
String
Neue E-Mail-Adresse.
Rückgabeparameter
changeApproverEMail Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
String
Kurze Erfolgsmeldung.
Die Rückgabe dieses Parameters erfolgt nur bei erfolgreicher Ausführung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur wenn Fehler aufgetreten sind).
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:resendApproverEmail>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<orderId>?</orderId>
</body>
</ns1:resendApproverEmail >
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:resendApproverEmail>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result>?</result> <-- if resultCount greater 0 -->
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:resendApproverEmail>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>getApproverEmailList
Diese Funktion liefert eine Liste von erlaubten E-Mail-Adressen für Domain-validierte Zertifikate.
Eingabeparameter
getApproverEmailList Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR"
Enthält die Daten zur Anmeldung bei EPAG.
product
ja
String
Bestellcode (Zertifikatstyp).
Siehe "Bestellbare Zertifikate"
hostName
ja
String
Domainname.
Rückgabeparameter
getApproverEmailList Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
String
Kurze Erfolgsmeldung.
Die Rückgabe dieses Parameters erfolgt nur bei erfolgreicher Ausführung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur wenn Fehler aufgetreten sind).
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:changeApproverEmail>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<orderId>?</orderId>
<email>?</email>
</body>
</ns1:changeApproverEmail>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:changeApproverEmail>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result>?</result> <-- if resultCount greater 0 -->
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:changeApproverEmail>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>cancelOrder
Über diese Funktion kann eine laufende Bestellung abgebrochen werden. Neu aufgegebene Bestellungen werden sofort abgebrochen. Bei Bestellungen, die in Bearbeitung sind, wird ein interner Vermerk gesetzt und es wird versucht die Bestellung so früh wie möglich zu stornieren.
Achtung:
Diese Funktion steht für GlobeSSL-Zertifkate nicht zur Verfügung.
Eingabeparameter
cancelOrder Eingabeparamater:
auth
ja
certAuth. Siehe "parseCSR"
Enthält die Daten zur Anmeldung bei EPAG.
orderId
ja
String
Zugehörige Bestellnummer.
reason
optional
String
Grund der Stornierung.
Rückgabeparameter
cancelOrder Rückgabeparameter:
resultCode
Integer
Ergebnis-Code der Funktion.
1 = erfolgreich.
-1 = gescheitert.
resultCount
Integer
Anzahl der in „result“ zurückgelieferten Ergebnisse.
result
String
Kurze Erfolgsmeldung.
Die Rückgabe dieses Parameters erfolgt nur bei erfolgreicher Ausführung.
errorCount
Integer
Anzahl der zurückgelieferten Fehlermeldungen.
error
certError
Einzelne Fehlermeldung oder Liste mit Fehlermeldungen
(Die Rückgabe dieses Parameters erfolgt nur wenn Fehler aufgetreten sind).
SOAP-Beispiele
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:cancelOrder>
<body>
<auth>
<username>?</username>
<password>?</password>
</auth>
<orderId>?</orderId>
<reason>?</reason>
</body>
</ns1:cancelOrder>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="epag.cert-order">
<SOAP-ENV:Body>
<ns1:cancelOrder>
<body>
<resultCode>?</resultCode> <-- success-code -->
<resultCount>?</resultCount> <-- number of result-elements -->
<result>?</result> <-- if resultCount greater 0 -->
<errorCount>?</errorCount> <-- number of error-elements -->
<error> <-- if errorCount greater 0 -->
<code>?</code>
<desc>?</desc>
<params> <-- zero, one or more elements -->
<name>a</name> <-- Param-Name -->
<value>b</value> <-- Param-Value -->
</params>
</error>
</body>
</ns1:cancelOrder>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>