Wersja 4.3 assecods.pl
Spis treści 1. WSTĘP... 5 1.1. Repozytorium API... 5 2. TYPY PRODUKTÓW... 6 2.1. Certyfikaty ID... 6 2.2. Certyfikaty SSL... 6 2.3. Certyfikaty Premium EV SSL... 6 2.4. Certyfikaty Code Signing... 6 2.5. Certyfikaty SNI... 6 3. PRZEGLĄD FUNKCJI WEBSERVICE... 7 3.1. Złożenie wniosku certyfikacyjnego... 7 3.2. Weryfikacja poprawności danych we wniosku... 7 3.3. Pobranie informacji o dostępnych metodach weryfikacji domeny... 8 3.4. Pobranie informacji o wnioskach i certyfikatach dla zadanego okresu czasu... 8 3.5. Pobranie informacji o wnioskach i certyfikatach, których status uległ zmianie dla zadanego okresu czasu... 8 3.6. Pobranie informacji o wniosku i certyfikacie dla zadanego identyfikatora wniosku... 8 3.7. Ponowienie wysłania maili weryfikacyjnych dla zadanego identyfikatora wniosku... 8 3.8. Pobranie oświadczenia... 8 3.9. Anulowanie zamówienia... 8 3.10. Unieważnienie certyfikatu... 8 3.11. Pobranie certyfikatu... 9 3.12. Pobranie konfiguracji wysyłki powiadomień... 9 3.13. Pobranie statusu weryfikacji domeny dla certyfikatów SSL... 9 3.14. Pobranie listy dostępnych produktów... 9 3.15. Odnowienie certyfikatu... 9 3.16. Wywołanie weryfikacji certyfikatu SSL... 9 3.17. Zmiana parametrów weryfikacji wniosku na certyfikat SSL... 9 3.18. Złożenie wniosku na certyfikat SNI... 9 3.19. Złożenie wniosku na modyfikację certyfikatu SNI... 9 3.20. Dodanie informacji weryfikujących do złożonego wniosku... 9 3.21. Pobranie informacji o wygasających certyfikatach... 9 3.22. Aktualizacja dokumentów... 10 3.23. Reissue (ponowne wydanie certyfikatu)... 10 4. STRUKTURA WEBSERVICE... 11 4.1. quickorderrequest... 11 4.2. quickorderresponse... 14 4.3. validateorderparametersrequest... 16 4.4. validateorderparametersresponse... 18 infolinia@
S t r o n a 3 4.5. getapproverlistrequest... 20 4.6. getapproverlistresponse... 20 4.7. getordersbydaterangerequest... 22 4.8. getordersbydaterangeresponse... 22 4.9. getmodifiedordersrequest... 26 4.10. getmodifiedordersresponse... 26 4.11. getorderbyorderidrequest... 30 4.12. getorderbyorderidresponse... 30 4.13. sendnotificationsrequest... 33 4.14. sendnotificationsresponse... 33 4.15. getstatementrequest... 34 4.16. getstatementresponse... 34 4.17. cancelorderrequest... 35 4.18. cancelorderresponse... 35 4.19. revokecertificaterequest... 36 4.20. revokecertificateresponse... 36 4.21. getcertificaterequest... 37 4.22. getcertificateresponse... 37 4.23. getconfigurationrequest... 38 4.24. getconfigurationresponse... 38 4.25. getdomainverificationrequest... 39 4.26. getdomainverificationresponse... 39 4.27. getemailverificationrequest... 41 4.28. getemailverificationresponse... 41 4.29. getproductlistrequest... 42 4.30. getproductlistresponse... 42 4.31. renewcertificaterequest... 44 4.32. renewcertificateresponse... 45 4.33. verifydomainrequest... 46 4.34. verifydomainresponse... 46 4.35. changeapproversrequest... 47 4.36. changeapproversresponse... 47 4.37. ordersnicertificaterequest... 48 4.38. ordersnicertificateresponse... 49 4.39. modifysnicertificaterequest... 50 4.40. modifysnicertificateresponse... 50 4.41. verifyorderrequest... 51 4.42. verifyorderresponse... 51 4.43. getexpiringcertificatesrequest... 53 4.44. getexpiringcertificatesresponse... 53
S t r o n a 4 4.45. updatedocumentsrequest... 54 4.46. updatedocumentsresponse... 54 4.47. reissuecertificaterequest... 55 4.48. reissuecertificateresponse... 55 4.49. getactivationcode... 56 4.50. getactivationcoderesponse... 56 5. GRUPY PRODUKTÓW... 57 5.1. Produkty w grupie Certyfikaty ID... 57 5.2. Produkty w grupie Certyfikaty SSL... 57 5.3. Produkty w grupie Certyfikaty Premium EV SSL... 59 5.4. Produkty w grupie Certyfikaty Code Signing... 59 5.5. Produkty w grupie Certyfikaty SpaceSSL... 60 6. DODATKOWE INFORMACJE... 61 6.1. Informacje dotyczące wiadomości email wysyłanych przez CERTUM... 61 6.2. Informacje dotyczące certyfikatów... 61 6.3. Metody automatycznej weryfikacji dla certyfikatów SSL... 66 6.3.1. Sekcja Approvers zakładanie rekordów weryfikacji dla certyfikatów SSL... 67 6.3.2. Zmiana parametrów weryfikacji dla certyfikatów SSL... 67 6.4. Proces składania zamówienia... 68 6.4.1. Unikalność pola <customer> w zamówieniu... 69 6.5. Opcje SAN dla certyfikatów SSL... 69 6.6. Proces anulowania zamówienia... 70 6.7. Dodatkowe opcje konfiguracyjne... 71 6.8. Certyfikaty SNI... 72 6.9. Dodawanie dokumentów... 73 6.9.1. Typy dokumentów... 73 6.10. Funkcjonalność reissue... 74 6.10.1. Reissue unieważnienie wygenerowanych certyfikatów... 74 6.11. Pola występujące w certyfikatach... 75 6.12. Statusy wniosków... 77 7. KODY BŁĘDÓW... 78 8. HISTORIA ZMIAN... 88
S t r o n a 5 1. Wstęp Program Partnerski CERTUM oferuje elastyczne i wydajne rozwiązanie oparte o SOAP (Simple Object Access Protocol) pozwalające na składanie wniosków certyfikacyjnych, sprawdzanie stanu realizacji wniosków i w dalszym etapie również zarządzanie certyfikatami bezpośrednio ze strony partnera. CERTUM Partner API pozwala na złożenie wniosku na certyfikat o dowolnym profilu (zgodnie z podpisaną umową partnerską) oraz monitorowanie statusu wniosku w miarę jego przetwarzania. CERTUM obsługuje proces weryfikacji domeny i/lub adresu email oraz może się kontaktować z klientem w przypadku, gdy niezbędne jest dostarczenie dokumentów. W ramach umowy z partnerskiej ustalane są między innymi takie kwestie jak: Produkty, do których partner ma dostęp W przypadku certyfikatów personalizowanych dedykowane polityki dla partnera Treści maili wysyłanych automatycznie przez system w procesie wydawania certyfikatów Zasady kontaktu CERTUM z klientami partnera 1.1. Repozytorium API Niniejsza dokumentacja jest cały czas rozwijana i uzupełniana o nowe informacje oraz funkcje dodawane do API. Dodatkowo w celu ułatwienia integracji z CERTUM API udostępniamy bibliotekę napisaną w PHP. Najnowsza wersja dokumentacji oraz biblioteki dostępna jest zawsze pod adresem: http://repository./api/ Dodatkowo CERTUM dostarcza graficzną implementację dostarczanych przez CERTUM API metod. Jest ona dostępna pod adresami: https://213.222.200.154/muc-api-client/ dla środowiska testowego https://gs./muc-api-client/ dla środowiska produkcyjne infolinia@
S t r o n a 6 2. Typy produktów 2.1. Certyfikaty ID Certyfikaty ID to certyfikaty oferowane w wariancie na 1-3 lata (z wyjątkiem certyfikatów testowych wydawanych na 90 dni), wystawiane są zawsze dla pojedynczego adresu email. Certyfikaty ID wymagają potwierdzenia przez klienta dostępu do adresu email podanego w certyfikacie. Weryfikacja dostępu do adresu email musi zostać przeprowadzona przez klienta. Dodatkowo weryfikowane są inne dane w certyfikacie jeśli profil certyfikatu to umożliwia i zostały one podane przez klienta. Lista produktów w grupie Certyfikaty ID 2.2. Certyfikaty SSL Certyfikaty SSL to certyfikaty oferowane w wariancie na 1-2 lata (z wyjątkiem certyfikatów testowych wydawanych na 30 dni), również w opcji Wildcard, w zależności od wariantu pozwalają na wprowadzenie 1-200 domen. Certyfikaty SSL wymagają potwierdzenia przez klienta dostępu do domeny dla której chcą uzyskać certyfikat. Weryfikacja dostępu do domeny może zostać przeprowadzona przez klienta. Lista produktów w grupie Certyfikaty SSL 2.3. Certyfikaty Premium EV SSL Certyfikaty Premium EV SSL to certyfikaty oferowane w wariancie na 1-2 lata, NIE mają dostępnej opcji Wildcard, w zależności od wariantu pozwalają na wprowadzenie 1-200 domen. Certyfikaty EV SSL wymagają dokładnej weryfikacji danych w nich zawartych oraz potwierdzenia przez klienta dostępu do domeny, dla której chcą uzyskać certyfikat. Proces pozyskania certyfikatu EV wymaga spełnienia specjalnych warunków. Aby uzyskać więcej informacji na temat tego produktu należy się skontaktować z CERTUM. Lista produktów w grupie Certyfikaty Premium EV SSL 2.4. Certyfikaty Code Signing Certyfikaty Code Signing to certyfikaty oferowane w wariancie 1-3 lata. Umożliwiają twórcom oprogramowania cyfrowe podpisanie oryginalnego kodu, a odbiorcom zweryfikowanie integralności danych na podstawie cyfrowego podpisu. Eliminują tym samym anonimowość aplikacji publikowanych w Internecie oraz zapewniają użytkownika końcowego, że program nie został zmodyfikowany (np. przez osoby nieuprawnione) od momentu jego podpisania przez wydawcę. Lista produktów w grupie Certyfikaty Code Signing 2.5. Certyfikaty SNI Certyfikat SNI jest specjalnym typem multidomenowego certyfikatu SSL. Jest to usługa stworzona z myślą o firmach hostingowych, które chcą ograniczyć użycie adresów IPv4 dla kolejnych domen. Więcej informacji o certyfikatach SNI infolinia@
S t r o n a 7 3. Przegląd funkcji WebService Ze względu na weryfikację leżącą po stronie klienta, procesy składania wniosku i wystawiania certyfikatu są asynchroniczne. Klient za pośrednictwem partnera składa wniosek. Po złożeniu wniosku partner powinien cyklicznie odpytywać CERTUM API w celu ustalenia czy certyfikat został wydany. 3.1. Złożenie wniosku certyfikacyjnego Za pomocą quickorder przekazywane są wszystkie informacje niezbędne do złożenia wniosku: Dane uwierzytelniające partnera (login i hasło) Identyfikator konta klienta końcowego Dane produktu (identyfikator produktu) Dane pozwalające na weryfikację klienta (imię i nazwisko klienta, dane kontaktowe, dane organizacji, identyfikator klienta w systemie partnera) Dane wniosku (CSR, okres ważności certyfikatu, email, dla którego będzie prowadzona weryfikacja) 3.2. Weryfikacja poprawności danych we wniosku Za pomocą funkcji validateorderparameters sprawdzane są wszystkie dane zawarte we wniosku. Sprawdzeniu podlegają zgodność danych zawartych w CSR z profilem certyfikatu, oraz zakres dostarczonych danych. W zależności od profilu certyfikatu podstawowy proces weryfikacji może być rozszerzony. W podstawowym wariancie sprawdzane są: 1. Login partnera a. poprawność loginu i hasła 2. Wniosek b. tożsamość i rodzaj konta partnera (w SSO podany jest typ partnerstwa) c. aktywność konta. a. czy identyfikator wniosku jest unikalny w bazie i poprawnie skonstruowany, b. czy Partner ma uprawnienia do składania wniosku na ten konkretnie produkt, c. czy jest podany login klienta (więcej informacji patrz rozdział 6.4.1), d. czy okres ważności certyfikatu mieści się w liczbie dni, jakie są przypisane dla danego kodu produktu, lub jeśli nie ma podanego zakresu dat wtedy certyfikat będzie wystawiony z datą początkową równą momentowi wystawienia, e. czy data od nie jest przeszła; zawsze musi być zastrzeżenie, że daty mogą ulec zmianie przy wystawianiu certyfikatu. f. czy data podana jest w formacie YYYY-MM-DD Uwaga: Dla certyfikatów Test SSL oraz Test ID sekcja <validityperiod> jest ignorowana 3. Poprawność CSR a. czy długość klucza nie jest mniejsza niż 2048 bitów, b. czy algorytm jest RSA, c. czy klucz nie występuje ani na blackliście ani na liście wykorzystanych kluczy d. czy wypełnione są wszystkie wymagane pola wymagalność pól jest określana w ramach profilu, e. czy pola mają dozwolony format, f. weryfikacja poprawności danych dołączonych do CSR dotyczących rozszerzenia SAN walidacja nazw domen. Szczegóły rozszerzonej weryfikacji mogą być sprecyzowane przy konkretnym produkcie/grupie produktów. W infolinia@
S t r o n a 8 razie pytań należy skontaktować się z CERTUM. 3.3. Pobranie informacji o dostępnych metodach weryfikacji domeny W przypadku certyfikatów SSL niezbędna jest weryfikacja dostępu do domeny. Aby zainicjować weryfikację należy wskazać adres email administratora domeny oraz wybrać jedną z dostępnych metod weryfikacji. W tym celu należy pobrać listę dopuszczalnych adresów wraz z metodami weryfikacji wykorzystując getapproverlist. Lista generowana jest na podstawie listy domen dostarczonych dla certyfikatu. 3.4. Pobranie informacji o wnioskach i certyfikatach dla zadanego okresu czasu Za pomocą GetOrdersByDateRange możliwe jest pobranie informacji o wnioskach i certyfikatach, (jeśli zostały wystawione) dla zadanego okresu czasu. Opcjonalnie można pobrać dodatkowe dane o wniosku i certyfikacie. Wyniki są stronicowane, na jednej stronie zwracana jest informacja o maksymalnie 100 zamówieniach. 3.5. Pobranie informacji o wnioskach i certyfikatach, których status uległ zmianie dla zadanego okresu czasu Za pomocą getmodifiedorders możliwe jest pobranie informacji o wnioskach i certyfikatach, (jeśli zostały wystawione), których status uległ zmianie w zadanym okresie czasu. Opcjonalnie można pobrać dodatkowe dane o wniosku i certyfikacie. Wyniki są stronicowane, na jednej stronie zwracana jest informacja o maksymalnie 100 zamówieniach. 3.6. Pobranie informacji o wniosku i certyfikacie dla zadanego identyfikatora wniosku Za pomocą getorderbyorderid możliwe jest pobranie pojedynczego wniosku dla zadanego identyfikatora wniosku. Opcjonalnie można pobrać dodatkowe dane o wniosku i certyfikacie. 3.7. Ponowienie wysłania maili weryfikacyjnych dla zadanego identyfikatora wniosku Za pomocą sendnotifications możliwe jest ponowne wysłanie maili weryfikacyjnych dla zadanego identyfikatora wniosku. Metoda nie umożliwia zmiany wybranych wcześniej parametrów weryfikacji, pozwala jedynie na ponowną ich wysyłkę. Wysyłane są wyłącznie te weryfikacje, które nie zostały przeprowadzone. Jeśli dla danego wniosku wszystkie weryfikacje są wykonane lub są jeszcze ważne, żadne wiadomości nie są wysyłane. 3.8. Pobranie oświadczenia Za pomocą getstatement możliwe jest pobranie oświadczenia, z jakim muszą się zapoznać, oraz jakie muszą zaakceptować klienci przed wygenerowaniem i złożeniem wniosku certyfikacyjnego. 3.9. Anulowanie zamówienia Za pomocą cancelorder możliwe jest anulowanie zamówienia. Partner może anulować zamówienie wyłącznie wygenerowane ze swojego konta. Jeśli do zamówienia został wydany certyfikat, przed anulowaniem zamówienia należy wcześniej unieważnić wydany certyfikat. Jeśli certyfikat do danego wniosku już wygasł anulowanie certyfikatu nie jest możliwe. 3.10. Unieważnienie certyfikatu Za pomocą revokecertificate możliwe jest unieważnienie certyfikatu. Partner może unieważnić certyfikaty wygenerowane wyłącznie ze swojego konta. Certyfikat można unieważnić w okresie jego ważności oraz przed uzyskaniem ważności. infolinia@
S t r o n a 9 3.11. Pobranie certyfikatu Za pomocą getcertificate możliwe jest pobranie certyfikatu w formacie PEM. Poza certyfikatem użytkownika zwracane są wszystkie certyfikaty pośrednie (subca) oraz certyfikat nadrzędny (rootca) również w formacie PEM. Partner może pobrać certyfikaty wygenerowane wyłącznie ze swojego konta. 3.12. Pobranie konfiguracji wysyłki powiadomień Za pomocą getconfiguration możliwe jest pobranie ustawień dotyczących wysyłki powiadomień mailowych dla skonfigurowanych produktów. 3.13. Pobranie statusu weryfikacji domeny dla certyfikatów SSL Za pomocą getdomainverification możliwe jest pobranie informacji o statusie weryfikacji dla wszystkich domen dla danego zamówienia. 3.14. Pobranie listy dostępnych produktów Za pomocą getproductlist możliwe jest pobranie listy produktów, które zostały skonfigurowane na koncie Partnera. 3.15. Odnowienie certyfikatu Za pomocą renewcertificate możliwe jest odnowienie certyfikatu. Odnowienie możliwe jest wyłącznie dla certyfikatów, które zostały wcześniej zamówione przez API z konta Partnera (odnowienie w ramach tego samego konta Partnera). 3.16. Wywołanie weryfikacji certyfikatu SSL Za pomocą verifydomain możliwe jest wywołanie weryfikacji FILE/DNS dla zamówień na certyfikaty SSL. 3.17. Zmiana parametrów weryfikacji wniosku na certyfikat SSL Za pomocą changeapprovers możliwa jest zmiana parametrów weryfikacji (EMAIL/FILE/DNS) dla złożonych wniosków certyfikacyjnych na certyfikaty SSL. 3.18. Złożenie wniosku na certyfikat SNI Za pomocą ordersnicertificate możliwe jest złożenie zamówienia na certyfikat SNI. Więcej informacji o certyfikatach SNI znajduje się w rozdziale 6.8. 3.19. Złożenie wniosku na modyfikację certyfikatu SNI Za pomocą modifysnicertificate możliwa jest modyfikacja istniejącego certyfikatu SNI (dodanie lub usunięcie domen z certyfikatu). 3.20. Dodanie informacji weryfikujących do złożonego wniosku Za pomocą verifyorder możliwe jest dodanie przez partnera do wniosku informacji (notatki oraz pliki z dokumentami), które będą mogły zostać wykorzystane przez pracowników CERTUM w procesie wydania certyfikatu. Więcej informacji na temat dokumentów znajduje się w rozdziale 6.9. 3.21. Pobranie informacji o wygasających certyfikatach infolinia@
S t r o n a 10 Za pomocą getexpiringcertificates możliwe jest pobranie listy certyfikatów wygasających za zadaną w żądaniu liczbę dni (certyfikaty wygasające w zakresie od 1-30 dni). 3.22. Aktualizacja dokumentów Za pomocą updatedocuments możliwa jest aktualizacji oraz uzupełnienie plików do dodanych wcześniej dokumentów. Więcej informacji na temat dokumentów znajduje się w rozdziale 6.9. 3.23. Reissue (ponowne wydanie certyfikatu) Za pomocą reissuecertificate możliwe jest ponowne wydanie certyfikatu na te same dane z zachowaniem daty końca ważności tego certyfikatu. Nowy certyfikat wydawany jest automatycznie, bez żadnej weryfikacji po stronie klienta/partnera, a jedyne dane, jakie można zmienić to klucz prywatny i wykorzystywana funkcja skrótu, (jeśli taka opcja dla danego produktu jest dostępna). Więcej informacji o funkcjonalności Reissie znajduje się w rozdziale 6.10. infolinia@
S t r o n a 11 4. Struktura WebService 4.1. quickorderrequest Żądanie powinno zawierać wszystkie dane potrzebne do złożenia zamówienia takie jak żądanie w postaci PKCS#10, kod produktu, dane wnioskującego o certyfikat oraz inne dane wymagane przez konkretny typ certyfikatu jak np. dane weryfikacji dla certyfikatów SSL. <quickorder> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <orderparameters> <CSR> 4000 String <customer> 255 String <language>? 2 String <orderid>? 50 String <productcode> 3 String <useragent>? 255 String (<validityperiod> <notafter> 25 YYYY-MM-DD <notbefore> 25 YYYY-MM-DD </validityperiod>)? <hashalgorithm>? String <email>? <activationcode>?</activationcode> <commonname>? 64 String <organization>? 64 String <organizationalunit>? 64 String <locality>? 128 String <country>? 2 String <state>? 128 String </orderparameters> (<SANEntries> (<SANEntry> <DNSName> 255 String </SANEntry>)+ </SANEntries>)? (<approvers> <verificationnotificationenabled>? true, false (<Approver> <FQDN> 255 String <approveremail>? 255 String <approvemethod>? DNS, FILE </Approver>)+ </approvers>)? <requestorinfo> <addressline1> 255 String <addressline2>? 255 String <city> 255 String <country> 2 String <email> 255 String <firstname> 255 String <lastname> 255 String <phone> 255 String <postalcode> 255 String </requestorinfo> (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String <verificationphonenumber>? 255 infolinia@
S t r o n a 12 </organizationinfo>)? </quickorder> 1. Dane do uwierzytelnienia login i hasło <quickorder> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> </quickorder> X username 255 znaków, Identyfikator partnera, musi być w SSO jako partner z atrybutem API X password Hasło zgodne z hasłem w SSO 2. Dane produktu w tych wnioskach jest to identyfikator kodu produktu, zawsze jeden produkt. <orderparameters> <customer> 255 String <language>? 2 String <orderid>? 50 String <productcode> 3 String <useragent>? 255 String </orderparameters> X customer 255 znaków. Login klienta w sklepie partnera (więcej informacji patrz rozdział 6.4.1). language Język w jakim mają do klienta trafiać mailingi domyślnie pl, dopuszczalne również ru, cn, en oraz es orderid 50 znaków, unikalne, identyfikator wniosku którym będzie posługiwał się partner. W przypadku, gdy nie zostanie podany, jest automatycznie nadawany przez system X productcode Kod produktu 3 cyfry, Lista kodów ID i SSL dostępna w dalszej części useragent 255 znaków, przeglądarka i system 3. Dane kontaktowe klienta będą potrzebne do weryfikacji poprawności wniosku. <requestorinfo> <addressline1> 255 String <addressline2>? 255 String <city> 255 String <country> 2 String <email> 255 String <firstname> 255 String <lastname> 255 String <phone> 255 String <postalcode> 255 String </requestorinfo> X addressline1 255 znaków, ulica, nr domu addressline2 255 znaków, ulica, nr domu infolinia@
S t r o n a 13 X city 255 znaków, miasto X country 2 znaki, kod kraju X email 255 znaków, email klienta X firstname 255 znaków, imię klienta X lastname 255 znaków, nazwisko klienta X phone 255 znaków, telefon X postalcode 255 znaków, kod pocztowy 4. Dane organizacji - będą potrzebne do weryfikacji poprawności wniosku. Podanie danych firmy nie jest wymagane, jednak jeśli są podane, to koniecznie wszystkie. (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String <verificationphonenumber>? 255 </organizationinfo>)? X organizationname 255 znaków, nazwa firmy X taxidentificationnumber 20 znaków, NIP albo inny numer identyfikacji podatkowej verificationphonenumber 255 znaków, numer telefonu (patrz rozdział 6.2) 5. Dane wniosku dane które mają trafić do certyfikatu czyli okres ważności, CSR oraz opcjonalnie dodatkowe domeny jako SAN. Dodatkowo w polach commonname, organization, organizationalunit, locality, country oraz state istnieje mozliwość zastąpienia zawartości CSR nowymi danymi. Ponadto, dla certyfikatów SSL przekazywana jest lista danych do weryfikacji domen. <orderparameters> <CSR> 4000 String (<validityperiod> <notafter> 25 YYYY-MM-DD <notbefore> 25 YYYY-MM-DD </validityperiod>)? <hashalgorithm>? String <email>? <activationcode>?</activationcode> <commonname>? 64 String <organization>? 64 String <organizationalunit>? 64 String <locality>? 128 String <country>? 2 String <state>? 128 String </orderparameters> (<SANEntries> (<SANEntry> <DNSName> 255 String </SANEntry>)+ </SANEntries>)? (<approvers> <verificationnotificationenabled>? true, false (<Approver> <FQDN> 255 String <approveremail>? 255 String <approvemethod>? DNS, FILE </Approver>)+ </approvers>)? X CSR Żądanie wydania certyfikatu w formacie PKCS#10. infolinia@
S t r o n a 14 notbefore notafter DNSName FQDN Początek okresu ważności certyfikatu. Koniec okresu ważności certyfikatu. 255 znaków każda domena. Domena która podlega weryfikacji. approveremail Adres email do wysłania weryfikacji (patrz rozdział 6.3). approvemethod Metoda weryfikacji, nie jest wymagana (patrz rozdział 6.3). verificationnotificationenabled Parametr określający, czy maile weryfikacyjne dotyczące weryfikacji FILE/DNS, mają być wysyłane. Przyjmuje wartości true - maile są wysyłane; false - maile nie są wysyłane. Parametr wpływa na wszystkie approvery z żądania. hashalgorithm email activationcode commonname organization organizationalunit locality country state Parametr określający funkcję skrótu, jaka ma zostać wykorzystana przy generacji certyfikatu. Dostępne funkcje skrótu dla danego produktu można uzyskać przez wywołanie metody getproductlist. (Tylko dla certyfikatów SSL). Podany przez subskrybenta adres email, który znajdzie się w certyfikacie. UWAGA: adres email subskrybenta jest weryfikowany przez CERTUM. Kod aktywacyjny. Pole CN Nazwa może zawierać imię i nazwisko klienta dla certyfikatu ID, lub nazwę domeny dla certyfikatu SSL Pole O organizacja Pole OU jednostka organizacyjna Pole L miejscowość Pole C kraj Pole SP województwo 4.2. quickorderresponse Zwraca potwierdzenie przyjęcia wniosku. Jeśli odpowiedź zawiera kod 0, oznacza to prawidłowe przyjęcie wniosku. W przeciwnym wypadku odpowiedź zawiera kod błędu. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <quickorderresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z </responseheader> <orderid>? 50 String <!- Nie zwracane w przypadku błędów --> (<verifications> <verification> <approvemethod> FILE, DNS <code> 50 String <fqdn> 255 String </verification> </verifications>)? </quickorderresponse> orderid Numer zamówienia infolinia@
S t r o n a 15 approvemethod code FQDN Metoda weryfikacji Kod weryfikacyjny Nazwa domeny, której dotyczy weryfikacja infolinia@
S t r o n a 16 4.3. validateorderparametersrequest Żądanie pozwala na przekazanie kompletu lub części danych do walidacji. Sprawdzeniu podlegają zgodność danych zawartych w CSR z profilem certyfikatu, oraz zakres dostarczonych danych. Te same walidatory są wykorzystywane w momencie składania wniosku metodą QuickOrder przy zapisie do bazy. Struktura całego żądania jest taka sama jak w przypadku QuickOrder. Poniżej opisane osobno kolejne sekcje żądania. 1. Dane do uwierzytelnienia login i hasło <validateorderparameters> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> </validateorderparameters> X username 255 znaków, Identyfikator partnera, musi być w SSO jako partner z atrybutem API X password Hasło zgodne z tym w SSO 2. Dane produktu w tych wnioskach jest to identyfikator kodu produktu, zawsze jeden produkt. <orderparameters> <customer> 255 String <language>? 2 String <orderid>? 50 String <productcode> 3 String <useragent>? 255 String </orderparameters> X customer 255 znaków, login klienta w sklepie partnera language Język w jakim mają do klienta trafiać mailingi domyślnie pl, dopuszczalne również ru, cn, en oraz es orderid 50 znaków, unikalne, identyfikator wniosku którym będzie posługiwał się partner. W przypadku, gdy nie zostanie podany, jest automatycznie nadawany przez system X productcode Kod produktu 3 cyfry, Lista kodów ID i SSL dostępna w dalszej części useragent 255 znaków, przeglądarka i system 3. Dane kontaktowe klienta będą potrzebne do weryfikacji poprawności wniosku. <requestorinfo> <addressline1> 255 String <addressline2>? 255 String <city> 255 String <country> 2 String <email> 255 String <firstname> 255 String <lastname> 255 String <phone> 255 String <postalcode> 255 String </requestorinfo> infolinia@
S t r o n a 17 X addressline1 255 znaków, ulica, nr domu addressline2 255 znaków, ulica, nr domu X city 255 znaków, miasto X country 2 znaki, kod kraju X email 255 znaków, email klienta X firstname 255 znaków, imię klienta X lastname 255 znaków, nazwisko klienta X phone 255 znaków, telefon X postalcode 255 znaków, kod pocztowy 4. Dane organizacji - będą potrzebne do weryfikacji poprawności wniosku. Podanie danych firmy nie jest wymagane, jednak jeśli są podane, to koniecznie wszystkie. (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String <verificationphonenumber>? 255 </organizationinfo>)? X organizationname 255 znaków, nazwa firmy X taxidentificationnumber 20 znaków, NIP albo inny numer identyfikacji podatkowej, system zakłada że zapisywane są znaki bez separatorów np. NIP pozbawiany jest myślników i spacji verificationphonenumber 255 znaków, numer telefonu (patrz rozdział 6.2) 5. Dane wniosku dane które mają trafić do certyfikatu czyli okres ważności, CSR oraz opcjonalnie dodatkowe domeny jako SAN. Dodatkowo dla certyfikatów SSL przekazywana jest lista danych do weryfikacji domen. <orderparameters> <CSR> 4000 String (<validityperiod> <notbefore> 25 YYYY-MM-DD <notafter> 25 YYYY-MM-DD </validityperiod>)? <hashalgorithm>? String <email>? <commonname>? 64 String <organization>? 64 String <organizationalunit>? 64 String <locality>? 128 String <country>? 2 String <state>? 128 String </orderparameters> (<SANEntries> (<SANEntry> <DNSName> 255 String </SANEntry>)+ </SANEntries>)? (<approvers> (<Approver> <FQDN> 255 String <approveremail> 255 String <approvemethod>? DNS, FILE </Approver>)+ </approvers>)? infolinia@
S t r o n a 18 X CSR Żądanie wydania certyfikatu w formacie PKCS#10 notbefore notafter DNSName FQDN początek okresu ważności certyfikatu koniec okresu ważności certyfikatu 255 znaków każda domena domena która podlega weryfikacji approveremail adres email do wysłania weryfikacji (patrz rozdział 6.3) approvemethod Metoda weryfikacji, nie jest wymagana (patrz rozdział 6.3) hashalgorithm commonname organization organizationalunit locality country state Parametr określający funkcję skrótu, jaka ma zostać wykorzystana przy generacji certyfikatu. Dostępne funkcje skrótu dla danego produktu można uzyskać przez wywołanie metody getproductlist. Pole CN Nazwa może zawierać imię i nazwisko klienta dla certyfikatu ID, lub nazwę domeny dla certyfikatu SSL Pole O organizacja Pole OU jednostka organizacyjna Pole L miejscowość Pole C kraj Pole SP województwo 4.4. validateorderparametersresponse Odpowiedź zwraca wyniki walidacji żądania certyfikacyjnego. Poprawna odpowiedź zwraca dane z żądania certyfikacyjnego (CSR) wyłącznie w zakresie pól, które zostaną dodane do certyfikatu, pozostałe pola są pomijane. Brak wymaganych jest sygnalizowany odpowiednim komunikatem. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <validateorderparametersresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z </responseheader> (<parsedcsr> <commonname> <country> <email>? <locality>? <organization>? <organizationunit>? <state>? </parsedcsr>)? </validateorderparametersresponse> X commonname Pole CN Nazwa może zawierać imię i nazwisko klienta dla certyfikatu ID, lub nazwę domeny dla certyfikatu SSL infolinia@
S t r o n a 19 country email locality organization organizationunit state Pole C kraj Pole E adres email Pole L miejscowość Pole O organizacja Pole OU jednostka organizacyjna Pole SP województwo infolinia@
S t r o n a 20 4.5. getapproverlistrequest Żądanie wykorzystywane tylko dla certyfikatów SSL, wymaga podania listy domen które mają trafić do certyfikatu. <getapproverlist> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <FQDNs> (<FQDN>)+ 255 String </FQDNs> </getapproverlist> X FQDN Domena która ma trafić do certyfikatu, w tym przypadku lista wszystkich domen które mają trafić do CN i SAN 4.6. getapproverlistresponse Odpowiedź zawiera listę domen dla których ustalono weryfikację, listę weryfikowanych adresów email dla każdej domeny oraz listę metod weryfikacji. Generacja listy przebiega według schematu: 1. Jeśli podana domena jest domeną drugiego stopnia (example.org), weryfikowana jest tylko ta domena 2. Jeśli podana jest subdomena (sub.example.org) weryfikacji podlega domena główna ALBO subdomena 3. Subdomeny są grupowane na podstawie domeny pierwszego stopnia dla tych subdomen, a. jeśli jest więcej niż jedna subdomena dla tej samej domeny pierwszego stopnia, weryfikacja może być przeprowadzona dla domeny pierwszego stopnia lub każdej subdomeny z osobna 4. Każda domena główna jest oznaczana przez atrybut maindomain= true Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <getapproverlistresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z <returncount> 5 </responseheader> <approvers> (<Approver maindomain= true > <FQDN> 255 String (<approveremail>)+ 255 String (<approvemethod>)* DNS, FILE </Approver>)+ (<Approver> <FQDN> 255 String (<approveremail>)+ 255 String (<approvemethod>)* DNS, FILE </Approver>)? </approvers> </getapproverlistresponse> infolinia@
S t r o n a 21 X FQDN Domena która ma być zweryfikowana X approveremail Lista adresów email dopuszczonych do weryfikacji: admin@domena.ta, administrator@domena.ta, hostmaster@domena.ta, webmaster@domena.ta, postmaster@domena.ta approvemethod Lista dostępnych metod weryfikacji: DNS, FILE X maindomain= true Oznaczenie domeny głównej. Jeśli została podana lista różnych domen i hostów, to każda domen głównych będzie oznaczona tym atrybutem. Weryfikacja domen oznaczonych tym atrybutem będzie wystarczająca do wydania certyfikatu. infolinia@
S t r o n a 22 4.7. getordersbydaterangerequest Żądanie wymaga podania dwóch parametrów w postaci zakresu dat. Wszystkie pozostałe parametry ustawione są domyślnie na false, więc brak tagów określających opcje odpowiedzi dla każdego zakresu dat zwraca odpowiedź zwierającą jedynie sumę rekordów spełniających kryteria. Zakres dat sprawdzany jest dla pola zawierającego datę utworzenia wniosku. <getorderbydatarange> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <fromdate> YYYY-MM-DD <todate> YYYY-MM-DD (<orderoption> (<orderstatus>)? true, false (<orderdetails>)? true, false (<certificatedetails>)? true, false </orderoption>)? <pagenumber>? 1..100 </getorderbydatarange> X fromdate Zakres dat dla złożonych wniosków, parametr wyszukiwania. Data musi być w formacie YYYY-MM-DD X todate Zakres dat dla złożonych wniosków, parametr wyszukiwania. Data musi być w formacie YYYY-MM-DD orderstatus orderdetails certificatedetails Brak tagu jest równoważny z ustawieniem na false. Zwraca podstawowe informacje o wniosku w tym status przetwarzania Brak tagu jest równoważny z ustawieniem na false. Zwraca szczegóły wniosku Brak tagu jest równoważny z ustawieniem na false. Zwraca szczegóły związane z certyfikatem jeśli został wydany X pagenumber Numer strony z wynikami. Przyjmuje wartości od 1 do 100. W jednym żądaniu zwracane jest maksymalnie 100 wyników. Jeśli liczba zwróconych rekordów jest większa niż 100 są one stronicowane. W przypadku nie podania tego parametru domyślnie ustawiana jest wartość 1 4.8. getordersbydaterangeresponse Odpowiedź zawiera informacje określone w żądaniu. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <getorderbydatarangeresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z infolinia@
S t r o n a 23 <currentpage> 1..100 <pagescount> 1..100 <returncount> 5 </responseheader> (<orders> (<Order> (<orderstatus> <orderid> 50 String <orderstatus> <orderdate> YYYY-MM-DDTHH:MM:SS.000Z <productcode> 3 String <customer> 255 String <serialnumber>? </orderstatus> )? <orderdetails> <requestorinfo> <firstname> 255 String <lastname> 255 String <addressline1> 255 String <addressline2>? 255 String <postalcode> 255 String <city> 255 String <country> 2 String <phone> 255 String <email> 255 String </requestorinfo> (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String </organizationinfo>)? </orderdetails>? <certificatedetails> <certificatestatus> VALID, REVOKING, REVOKED <startdate> 25 YYYY-MM-DDTHH:MM:SS.000Z <enddate> 25 YYYY-MM-DDTHH:MM:SS.000Z <commonname> 64 String <serialnumber> 64 String <subjectname> 3000 String (<DNSNames>)? 300 String (<revokeddate>)? 25 YYYY-MM-DDTHH:MM:SS.000Z <X509Cert> 4000 String </certificatedetails>? </Order>)* <orders>)? </getorderbydatarangeresponse> 1. Podstawowe informacje odpowiedzi <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z <currentpage> 1..100 <pagescount> 1..100 <returncount> 5 </responseheader> X currentpage Informacja, która strona wyników jest wyświetlana X pagescount Informacja o całkowitej liczbie stron X returncount Informacja o całkowitej liczbie rekordów 2. Podstawowe informacje o wniosku infolinia@
S t r o n a 24 (<orderstatus> <orderid> 50 String <orderstatus> <orderdate> YYYY-MM-DDTHH:MM:SS.000Z <productcode> 3 String <customer> 255 String <serialnumber>? </orderstatus>)? orderid 50 znaków, unikalne w bazie X orderstatus status wniosku X orderdate data złożenia wniosku X productcode Kod produktu 3 cyfry Lista kodów ID i SSL dostępna w dalszej części dokumentu. X customer 255 znaków, login klienta w sklepie partnera serialnumber 3. Rozszerzone informacje o wniosku <orderdetails> <requestorinfo> <firstname> 255 String <lastname> 255 String <addressline1> 255 String <addressline2>? 255 String <postalcode> 255 String <city> 255 String <country> 2 String <phone> 255 String <email> 255 String </requestorinfo> (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String </organizationinfo>)? </orderdetails>? X firstname 255 znaków, imię klienta X lastname 255 znaków, nazwisko klienta X addressline1 255 znaków, ulica, nr domu addressline2 Numer seryjny certyfikatu, zwracany gdy certyfikat istnieje, numer certyfikatu w formacie HEX 255 znaków, ulica, nr domu X postalcode 255 znaków, kod pocztowy X city 255 znaków, miasto X country 2 znaki, kod kraju X email 255 znaków, email klienta X phone 255 znaków, telefon X organizationname 255 znaków, nazwa firmy X taxidentificationnumber 20 znaków, NIP albo inny numer identyfikacji podatkowej, system zakłada że zapisywane są znaki bez separatorów np. NIP pozbawiany jest myślników i spacji przed zapisem 4. Rozszerzone informacje o certyfikacie <certificatedetails> infolinia@
S t r o n a 25 <certificatestatus> VALID, REVOKING, REVOKED <startdate> 25 YYYY-MM-DDTHH:MM:SS.000Z <enddate> 25 YYYY-MM-DDTHH:MM:SS.000Z <commonname> 64 String <serialnumber> 64 String <subjectname> 3000 String (<DNSNames>)? 300 String (<revokeddate>)? 25 YYYY-MM-DDTHH:MM:SS.000Z <X509Cert> 4000 String </certificatedetails>? X certificatestatus 255 znaków, status VALID, REVOKING, REVOKED X startdate timestamp without time zone, data początku ważności X enddate timestamp without time zone, data końca ważności X commonname nazwa powszechna może zawierać imię i nazwisko klienta dla certyfikatu ID, lub nazwę domeny dla certyfikatu SSL X serialnumber numer seryjny certyfikatu w formacie HEX X subjectname text, zawartość pola Podmiot DNSNames revokeddate text, zawartość pól DNS timestamp without time zone, data unieważnienia X X509Cert Certyfikat w formacie base64 infolinia@
S t r o n a 26 4.9. getmodifiedordersrequest Żądanie wymaga podania dwóch parametrów w postaci zakresu dat. Wszystkie pozostałe parametry ustawione są domyślnie na false, więc brak tagów określających opcje odpowiedzi dla każdego zakresu dat zwracają pustą odpowiedź zwierającą jedynie sumę rekordów spełniających kryteria. Zakres dat sprawdzany jest dla pola zawierającego datę zmiany statusu wniosku. <getmodifiedorders> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <fromdate> YYYY-MM-DD <todate> YYYY-MM-DD (<orderoption> (<orderstatus>)? true, false (<orderdetails >)? true, false (<certificatedetails>)? true, false </orderoption>)? <pagenumber>? 1..100 </getmodifiedorders> X fromdate Zakres dat zmiany statusu wniosku, parametr wyszukiwania. Data musi być w formacie YYYY-MM-DD X todate Zakres dat zmiany statusu wniosku, parametr wyszukiwania. Data musi być w formacie YYYY-MM-DD orderstatus orderdetails certificatedetails pagenumber Obecność tego tagu zwraca podstawowe informacje o wniosku w tym status przetwarzania Brak tagu jest równoważny z ustawieniem na false. Zwraca szczegóły wniosku Brak tagu jest równoważny z ustawieniem na false. Zwraca szczegóły związane z certyfikatem jeśli został wydany w tym wydany certyfikat Numer strony z wynikami. Przyjmuje wartości od 1 do 100. W jednym żądaniu zwracane jest maksymalnie 100 wyników. Jeśli liczba zwróconych rekordów jest większa niż 100 są one stronicowane. W przypadku nie podania tego parametru domyślnie ustawiana jest wartość 1 4.10. getmodifiedordersresponse Odpowiedź zawiera informacje określone w żądaniu. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <getmodifiedordersresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? infolinia@
S t r o n a 27 <timestamp> YYYY-MM-DDTHH:MM:SS.000Z <currentpage> 1..100 <pagescount> 1..100 <returncount> 5 </responseheader> (<orders> (<Order> (<orderstatus> <orderid> 50 String <orderstatus> <orderdate> YYYY-MM-DDTHH:MM:SS.000Z <productcode> 3 String <customer> 255 String <serialnumber>? </orderstatus> )? <orderdetails> <requestorinfo> <firstname> 255 String <lastname> 255 String <addressline1> 255 String <addressline2>? 255 String <postalcode> 255 String <city> 255 String <country> 2 String <phone> 255 String <email> 255 String </requestorinfo> (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String </organizationinfo>)? </orderdetails>? <certificatedetails> <certificatestatus> VALID, REVOKING, REVOKED <startdate> 25 YYYY-MM-DDTHH:MM:SS.000Z <enddate> 25 YYYY-MM-DDTHH:MM:SS.000Z <commonname> 64 String <serialnumber> 64 String <subjectname> 3000 String (<DNSNames>)? 300 String (<revokeddate>)? 25 YYYY-MM-DDTHH:MM:SS.000Z <X509Cert> 4000 String </certificatedetails>? </Order>)* <orders>)? </getmodifiedordersresponse> 1. Podstawowe informacje odpowiedzi <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>) + </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z <currentpage> 1..100 <pagescount> 1..100 <returncount> 5 </responseheader> X currentpage Informacja, która strona wyników jest wyświetlana X pagescount Informacja o całkowitej liczbie stron X returncount Informacja o całkowitej liczbie rekordów 2. Podstawowe informacje o wniosku infolinia@
S t r o n a 28 (<orderstatus> <orderid> 50 String <orderstatus> <orderdate> YYYY-MM-DDTHH:MM:SS.000Z <productcode> 3 String <customer> 255 String <serialnumber>? </orderstatus> )? orderid 50 znaków, unikalne w bazie X orderstatus status wniosku X orderdate data złożenia wniosku X productcode Kod produktu 3 cyfry Lista kodów ID i SSL dostępna w dalszej części X customer 255 znaków, login klienta w sklepie partnera serialnumber 3. Rozszerzone informacje o wniosku <orderdetails> <requestorinfo> <firstname> 255 String <lastname> 255 String <addressline1> 255 String <addressline2>? 255 String <postalcode> 255 String <city> 255 String <country> 2 String <phone> 255 String <email> 255 String </requestorinfo> (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String </organizationinfo>)? </orderdetails>? X firstname 255 znaków, imię klienta X lastname 255 znaków, nazwisko klienta X addressline1 255 znaków, ulica, nr domu addressline2 Numer seryjny certyfikatu, zwracany gdy certyfikat istnieje, numer certyfikatu w formacie HEX 255 znaków, ulica, nr domu X postalcode 255 znaków, kod pocztowy X city 255 znaków, miasto X country 2 znaki, kod kraju X email 255 znaków, email klienta X phone 255 znaków, telefon X organizationname 255 znaków, nazwa firmy X taxidentificationnumber 20 znaków, NIP albo inny numer identyfikacji podatkowej, system zakłada że zapisywane są znaki bez separatorów np. NIP pozbawiany jest myślników i spacji 4. Rozszerzone informacje o certyfikacie <certificatedetails> infolinia@
S t r o n a 29 <certificatestatus> VALID, REVOKING, REVOKED <startdate> 25 YYYY-MM-DDTHH:MM:SS.000Z <enddate> 25 YYYY-MM-DDTHH:MM:SS.000Z <commonname> 64 String <serialnumber> 64 String <subjectname> 3000 String (<DNSNames>)? 300 String (<revokeddate>)? 25 YYYY-MM-DDTHH:MM:SS.000Z <X509Cert> 4000 String </certificatedetails>? X certificatestatus 255 znaków, status VALID, REVOKING, REVOKED X startdate data początku ważności certyfikatu X enddate data końca ważności certyfikatu X commonname nazwa powszechna może zawierać imię i nazwisko klienta dla certyfikatu ID, lub nazwę domeny dla certyfikatu SSL X serialnumber numeric(44,2) X subjectname text, zawartość pola Podmiot DNSNames revokeddate X509Cert text, zawartość pól DNS data unieważnienia certyfikatu Certyfikat w formacie base64 infolinia@
S t r o n a 30 4.11. getorderbyorderidrequest Żądanie wymaga podania jednego parametru w postaci numeru wniosku. Wszystkie pozostałe parametry ustawione są domyślnie na false, więc brak tagów określających opcje odpowiedzi zwraca pustą odpowiedź. <getorderbyorderid> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <orderid> 50 String (<orderoption> (<orderstatus>)? true, false (<orderdetails >)? true, false (<certificatedetails>)? true, false </orderoption>)? </getorderbyorderid> X orderid Identyfikator wniosku orderstatus orderdetails certificatedetails Obecność tego tagu zwraca podstawowe informacje o wniosku w tym status przetwarzania Brak tagu jest równoważny z ustawieniem na false. Zwraca szczegóły wniosku Brak tagu jest równoważny z ustawieniem na false. Zwraca szczegóły związane z certyfikatem jeśli został wydany w tym wydany certyfikat 4.12. getorderbyorderidresponse Odpowiedź zawiera informacje określone w żądaniu. Zawsze powinno istnieć tylko jedno zamówienie o danym ID, które ma jeden produkt i jeden wniosek. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <getorderbyorderidresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>) + </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z <returncount> 5 </responseheader> (<orders> (<Order reissue= true > (<orderstatus> <orderid> 50 String <orderstatus> <orderdate> YYYY-MM-DDTHH:MM:SS.000Z <productcode> 3 String <customer> 255 String <serialnumber>? </orderstatus> )? <orderdetails> infolinia@
S t r o n a 31 <requestorinfo> <firstname> 255 String <lastname> 255 String <addressline1> 255 String <addressline2>? 255 String <postalcode> 255 String <city> 255 String <country> 2 String <phone> 255 String <email> 255 String </requestorinfo> (<organizationinfo> <organizationname> 255 String <taxidentificationnumber> 20 String </organizationinfo>)? </orderdetails>? <certificatedetails> <certificatestatus> VALID, REVOKING, REVOKED <startdate> 25 YYYY-MM-DDTHH:MM:SS.000Z <enddate> 25 YYYY-MM-DDTHH:MM:SS.000Z <commonname> 64 String <serialnumber> 64 String <subjectname> 3000 String (<DNSNames>)? 300 String (<revokeddate>)? 25 YYYY-MM-DDTHH:MM:SS.000Z <X509Cert> 4000 String </certificatedetails>? </Order>)? <orders>)? </getorderbyorderidresponse> 1. Podstawowe informacje o wniosku (<orderstatus> <orderid> 50 String <orderstatus> <orderdate> YYYY-MM-DDTHH:MM:SS.000Z <productcode> 3 String <customer> 255 String <serialnumber>? </orderstatus>)? orderid 50 znaków, unikalne w bazie X orderstatus status wniosku X orderdate data złożenia wniosku X productcode Kod produktu 3 cyfry Lista kodów ID i SSL dostępna w dalszej części. X customer 255 znaków, login klienta w sklepie partnera serialnumber Numer seryjny certyfikatu, zwracany gdy wniosek ma wygenerowany certyfikat 2. Rozszerzone informacje o wniosku (<orderdetails> <requestorinfo> <firstname> 255 String <lastname> 255 String <addressline1> 255 String <addressline2>? 255 String <postalcode> 255 String <city> 255 String <country> 2 String <phone> 255 String <email> 255 String </requestorinfo> (<organizationinfo> infolinia@
S t r o n a 32 <organizationname> 255 String <taxidentificationnumber> 20 String </organizationinfo>)? </orderdetails>)? X firstname 255 znaków, imię klienta X lastname 255 znaków, nazwisko klienta X addressline1 255 znaków, ulica, nr domu addressline2 255 znaków, ulica, nr domu X postalcode 255 znaków, kod pocztowy X city 255 znaków, miasto X country 2 znaki, kod kraju X email 255 znaków, email klienta X phone 255 znaków, telefon X organizationname 255 znaków, nazwa firmy X taxidentificationnumber 20 znaków, NIP albo inny numer identyfikacji podatkowej, system zakłada że zapisywane są znaki bez separatorów np. NIP pozbawiany jest myślników i spacji przed zapisem 3. Rozszerzone informacje o certyfikacie (<certificatedetails> <certificatestatus> VALID, REVOKING, REVOKED <startdate> 25 YYYY-MM-DDTHH:MM:SS.000Z <enddate> 25 YYYY-MM-DDTHH:MM:SS.000Z <commonname> 64 String <serialnumber> 64 String <subjectname> 3000 String (<DNSNames>)? 300 String (<revokeddate>)? 25 YYYY-MM-DDTHH:MM:SS.000Z <X509Cert> 4000 String </certificatedetails>)? X certificatestatus 255 znaków, status VALID, REVOKING, REVOKED X startdate data początku ważności certyfikatu X enddate data końca ważności certyfikatu X commonname nazwa powszechna występująca w certyfikacie X serialnumber Numer seryjny certyfikatu w postaci HEX X subjectname text, zawartość pola Podmiot DNSNames revokeddate text, zawartość pól DNS data unieważnienia certyfikatu X X509Cert Certyfikat w formacie base64 infolinia@
S t r o n a 33 4.13. sendnotificationsrequest Żądanie wymaga podania jednego parametru w postaci numeru wniosku. <sendnotifications> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <orderid> 50 String </sendnotifications> X orderid Identyfikator wniosku 4.14. sendnotificationsresponse Odpowiedź zawiera informację o poprawnym przyjęciu żądania. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <sendnotificationsresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z </responseheader> </sendnotificationsresponse> infolinia@
S t r o n a 34 4.15. getstatementrequest Żądanie wymaga podania jednego parametru w postaci języka. <getstatement> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <language> 2 String </getstatement> X language 2 znakowy kod kraju zgodny z ISO3166-1 4.16. getstatementresponse Odpowiedź zawiera treść oświadczenia w żądanym języku. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <getstatementresponse> <responseheader> <successcode> 2 (<errors> (<error> <errorcode> 5 </error>)+ </errors>)? <timestamp> YYYY-MM-DDTHH:MM:SS.000Z </responseheader> <statement>? String </getstatementresponse> statement Treść oświadczenia w żądanym języku infolinia@
S t r o n a 35 4.17. cancelorderrequest Żądanie wymaga podania parametru w postaci numeru zamówienia oraz opcjonalnie notatkę, jaka zostanie dodana do anulowanego wniosku. <cancelorder> <requestheader> <authtoken> <username> 255 String <password> 255 String </authtoken> </requestheader> <cancelparameters> <note>? 255 String <orderid> 50 String </cancelparameters> </cancelorder> X orderid Identyfikator wniosku note 4.18. cancelorderresponse Notatka dotycząca przyczyny anulowania zamówienia Odpowiedź zawiera informację o poprawnym przyjęciu żądania. Jeśli do danego żądania został wydany certyfikat, który należy najpierw unieważnić jego numer seryjny jest zwracany w postaci HEX. Lista kodów błędów wraz z opisem znajduje się w rozdziale 7. Kody błędów. <cancelorderresponse> <responseheader> (<errors> (<error> <errorcode> 5 <value>? 64 String </error>)+ </errors>)? <successcode> 2 <timestamp> YYYY-MM-DDTHH:MM:SS.000Z </responseheader> </cancelorderresponse> value Numer seryjny certyfikatu w postaci HEX infolinia@