Modul Certificate

Komenda: generatePKEY

Opis komendy

Komenda pozwala na wygenerowanie klucza prywatnego o długości 2048 bitów.

Zwracane dane

Zwracane daneOpis
pkeywygenerowany klucz prywatny

Przykładowa komenda

generatePKEY()

$response = $soap->generatePKEY();

Przykładowa odpowiedź:

{"status":true,"pkey":"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDWc3TX55k72Gth\nkIKP903475OldM2PgDZyB47zQwTffOzWbrqjBMOGLLBtwgZaoIXlyImyOwMBsfqk\nusKkE4EZ9xpwZmwuCfJy2JlnxvPZzfDcm1CkvhVOJJqThQPwUBHHcvHJ\/24Dt87f\n3rqyfKj4YOoRNqB0Pc41yx78CG2Th6hEnszxAQzTpz8evG97KPcqyJV1uEYIyDUs\nfzahdxEIJ9C+7G4qXZZ3T6RwoyoKc3JUtJ\/g2NWcOvS6w5scbRxwBWFU9RflYCAn\nUBdjJSbU22Yip\/5grFjJ398Hw3jWaRu4o2DTpcQ+Gad9nbhN5bR7DdcKbDRHBASq\nAVPUZn3pAgMBAAECggEAAmsM3z5iUPVwyInbnwn33B2\/eXcmtj6I3qJNL1sLHAYJ\nmaVn\/1yXY9TvLF2quqzitaOcQeE+eG9sVx0wAq+hngxWRPwyrhY4oKjmme\/5YfRb\nifFKaIEoNlhdUdqHH9eXS7t1FIUH1YzmDUoyqr6THTHikc0e5BCqWZrvv4HM0oQI\nyW5gL4S8j4fBrOrWy2dYAdgxfZsizyZDPZ1sF8f3JV0VKoJ31C+Gd23uGwWXjplu\nfYedsNKU0qA1kJ7taifAdJ0zA2cdhwughmT2nan2gBLe2Re\/TAqUIIoPzb2aLmkd\n3hql16lxaQdpj2Zhjin9EUoZSZ4yep2AIu634WUCgQKBgQD+RMN3HpYgcVsTcmJg\nLSWkvvVk6\/Yatkk0e3Z4kp5M+L8Cw5oBWMrTV7W\/YdtnNhLOKnHwVETE3Vzvamfa\nqjz6M+uPDlcokOFRp5mrHdCfhkqCzLPqreZSDH5uaDEEbE86dTYVOI7Zna1lcf5h\nBtU6MFePrlCaPLTwuukfiW3m0QKBgQDX6UiWo1USZabcHGlm3Qi45QAbefPotj0M\ngxPtyu3sIVf+RkYu7jP3GevPQBNs2kU+VS3TE+6aM0BWFlYyYzwL8AJk8mTM+rh1\nzzf6bgGtvwWoHJbBq+Npxfm+Sd4AA85D6jhQAH1uGbqwndRbl5cnDmDcan1BxQh+\n026Gs0ebmQKBgQDaii+WSmuuJr+ozz9Oen9IQfiYbVZxTwtMWHFS4HG+pm1F6uiL\nD84EJ\/bGL01sQEWZfVHAxiz1J22hOUtZ3cfbJJTpt+GhtCR1EiA5ur583edc1KQu\nqJi1HJfuPQ8kRhMyo1uAkcP1tlg6QOfqbP0HrlUT4TbV2ieKYJvNx0j2gQKBgElc\nnqlwfetuVq\/bh4TH\/bq1NMAhQ9sCcOPbdd4KYaUl\/zwKrLYtgcKoMBOPdgo6b+Sq\nFJPv5dbHK0kU9dzREwoLVwTtx4pOdnaxHhgdYLykd0uTyzWrLe42spERkDj5EhDJ\neLDWOcg7Pc\/dENa+P0GqBQdft4etZyGQvbFPITmhAoGBANqa8F3RijKg0xYnZ+vK\n5dygdC14sKXzob41FaN2BFeXhQ2KeefPIPZgQfRizzRD1gZpzw7Mw22Z3KAU+AYK\nqr0GCBpxLchW684fqix8LrsfrAfvdWqQDpErIUtbor+djDLm4wzqIkuGw\/nkvNV9\nfOdPduGkCJgKr80pu4xcXJNR\n-----END PRIVATE KEY-----\n"}

Komenda: generateCSR

Opis komendy

Komenda pozwala na wygenerowanie żądania podpisania certyfikatu (CSR = Certificate Signing Request).

Parametry

Parametr Opis
pkey klucz prywatny
organizationNazwa firmy
department(pole opcjonalne) wydział
commonNamenazwa domeny do której będzie generowany certyfikat (dla wildcard musi się zaczynać od *.)
emailadres email
statewojewództwo
citymiasto
countrydwuliterowy kod kraju

Zwracane dane

Zwracane daneOpis
csrwygenerowane żądanie certyfikatu

Przykładowa komenda

generateCSR($pkey, $organization, $department, $commonName, $email, $state, $city, $country)

$response = $soap->generateCSR("-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBg.......CJgKr80pu4xcXJNR\n-----END PRIVATE KEY-----\n", "Firma testowa", "", "testowadomena.pl", "biuro@testowadomena.pl", "mazowieckie", "Warszawa", "PL");

Przykładowa odpowiedź:

{"status":true,"csr":"-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwgYExC...........mV2zyI\/FfLiee4M9Rd92wOedOWLCVuHg2Y26lg==\n-----END CERTIFICATE REQUEST-----\n"}

Komenda: register

Opis komendy

Komenda pozwala na wygenerowanie wniosku rejestracji certyfikatu. Aktywacja wniosku następuje poprzez komendę activateById modułu Invoice.

Dostępne certyfikaty

Id certyfikatuNazwa CertyfikatuDostępne odnowienieDodatkowe pola orgDodatkowe okresy
2RapidSSLtak 12, 24, 36
3RapidSSL Wildcardtak12, 24, 36
5QuickSSL Basictak12, 24, 36
6QuickSSL Premiumtak12, 24, 36
7True BusinessIDtaktak12, 24, 36
8True BusinessID Wildcardtaktak12, 24, 36
9True BusinessID + EVtaktak12, 24
14Secure Sitetaktak12, 24, 36
15Secure Site Protaktak12, 24, 36
16Secure Site + EVtaktak12, 24
17Secure Site Pro + EVtaktak12, 24
19SSL123taktak12, 24, 36

Parametry

ParametrOpis
certIdnr certyfikatu
periodokres w miesiącach zgodny z certyfikatem
emailemail na który przyjdzie potwierdzenie rejestracji certyfikatu
login musi być jednym z poniższych („admin”, „administrator”, „hostmaster”, „webmaster”, „postmaster”) domena adresu musi być domeną certyfikatu
clientNumer konta abonenckiego CSA, na którym ma zostać zarejestrowana domena
csrżądanie podpisania certyfikatu
Administrator certyfikatu
admTitledostępne wartości („Mrs”, „Mr”, „Miss”, „Ms”, „Dr”)
admFirstNameimię 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admLastNamenazwisko 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admOrganizationnazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admRolejedna z listy („Business Owner”, „Company Director”, „WebSite Owner”, „IT Department”, „Other”)
admEmailadres email
admPhoneCCnumer kierunkowy kraju np. +48
admPhoneACnumer kierunkowy telefonu np. 22 lub 500
admPhoneNpozostały numer telefonu
admAddress1adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
admCitymiasto
admStatewojewództwo
admPostCodekod pocztowy
admCountrydwuliterowy kod kraju
Dane organizcji (wymagane tylko dla wyższych certyfikatów)
orgOrganizationnazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
orgPhoneCCnumer kierunkowy kraju np. +48
orgPhoneACnumer kierunkowy telefonu np. 22 lub 500
orgPhoneNpozostały numer telefonu
orgAddress1adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
orgCitymiasto
orgStatewojewództwo
orgPostCodekod pocztowy
orgCountrydwuliterowy kod kraju

Zwracane dane

Zwracane daneOpis
wnIdNumer identyfikacyjny wniosku

Przykładowa komenda

register($certId, $period, $email, $client, $csr, $admTitle, $admFirstName, $admLastName, $admOrganization, $admRole, $admEmail, $admPhoneCC, $admPhoneAC, $admPhoneN, $admAddress1, $admCity, $admState, $admPostCode, $admCountry, $orgOrganization, $orgPhoneCC, $orgPhoneAC, $orgPhoneN, $orgAddress1, $orgCity, $orgState, $orgPostCode, $orgCountry)

$response = $soap->register(1, 1, "admin@testowadomen.pl", "csa0000", "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwgYExC...........mV2zyI\/FfLiee4M9Rd92wOedOWLCVuHg2Y26lg==\n-----END CERTIFICATE REQUEST-----\n", "Mr", "Test", "Testowy", "Test Sp.z o.o.", "Company Director", "test@domenatestowa.pl", "+48", "22", "123456", "testowa 1 m. 1", "Warszawa", "mazowieckie", "00-000", "PL");

Przykładowa odpowiedź

{"status":true,"wnId":"12300123"}

Komenda: renew

Opis komendy

Komenda pozwala na wygenerowanie wniosku odnowienie certyfikatu.
Certyfikat można odnowić w każdym momencie przed upłynięciem okresu bieżącego certyfikatu, okresy ważności nie sumują się. Aktywacja wniosku następuje poprzez komendę activateById modułu Invoice.

Parametry

ParametrOpis
certIdnr certyfikatu
periodokres w miesiącach zgodny z certyfikatem
emailemail na który przyjdzie potwierdzenie rejestracji certyfikatu
login musi być jednym z poniższych („admin”, „administrator”, „hostmaster”, „webmaster”, „postmaster”)
domena adresu musi być domeną certyfikatu
clientNumer konta abonenckiego CSA, na którym ma zostać zarejestrowana domena
csrżądanie podpisania certyfikatu
Administrator certyfikatu
admTitledostępne wartości (Mrs, Mr, Miss, Ms, Dr)
admFirstNameimię 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admLastNamenazwisko 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admOrganizationnazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admRolejedna z listy („Business Owner”, „Company Director”, „WebSite Owner”, „IT Department”, „Other”)
admEmailadres email
admPhoneCCnumer kierunkowy kraju np. +48
admPhoneACnumer kierunkowy telefonu np. 22 lub 500
admPhoneNpozostały numer telefonu
admAddress1adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
admCitymiasto
admStatewojewództwo
admPostCodekod pocztowy
admCountrydwuliterowy kod kraju
Dane organizcji (wymagane tylko dla wyższych certyfikatów)
orgOrganizationnazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
orgPhoneCCnumer kierunkowy kraju np. +48
orgPhoneACnumer kierunkowy telefonu np. 22 lub 500
orgPhoneNpozostały numer telefonu
orgAddress1adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
orgCitymiasto
orgStatewojewództwo
orgPostCodekod pocztowy
orgCountrydwuliterowy kod kraju

Zwracane dane

Zwracane daneOpis
wnIdNumer identyfikacyjny wniosku

Przykładowa komenda

renew($certId, $period, $email, $client, $csr, $admTitle, $admFirstName, $admLastName, $admOrganization, $admRole, $admEmail, $admPhoneCC, $admPhoneAC, $admPhoneN, $admAddress1, $admCity, $admState, $admPostCode, $admCountry, $orgOrganization, $orgPhoneCC, $orgPhoneAC, $orgPhoneN, $orgAddress1, $orgCity, $orgState, $orgPostCode, $orgCountry)

$response = $soap->renew(1, 1, "admin@testowadomen.pl", "csa0000", "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwgYExC...........mV2zyI\/FfLiee4M9Rd92wOedOWLCVuHg2Y26lg==\n-----END CERTIFICATE REQUEST-----\n", "Mr", "Test", "Testowy", "Test Sp.z o.o.", "Company Director", "test@domenatestowa.pl", "+48", "22", "123456", "testowa 1 m. 1", "Warszawa", "mazowieckie", "00-000", "PL");

Przykładowa odpowiedź

{"status":true,"wnId":"12300123"}

Komenda: listAll

Opis komendy

Komenda zwraca listę identyfikatorów certyfikatów zarejestrowanych na koncie partnera z limitem 100 kont na komendę; przesunięcie pozwala na wyświetlenie kolejnych numerów kont.

Parametry

ParametrOpis
offsetprzesunięcie pozwalające na wyświetlenie kolejnych identyfikatorów

Zwracane dane

Zwracane daneOpis
maxilość certyfikatów obsługiwanych przez Partnera
certstablica identyfikatorów certyfikatów

Przykładowa komenda

listAll(100)

$response = $soap->listAll(100);

Przykładowa odpowiedź

{"status":true,"max":"104","certs":["435345345435","456456355","6867856767","675686965577"]}

Komenda: listByClient

Opis komendy

Komenda zwraca listę identyfikatorów certyfikatów zarejestrowanych na koncie klienta z limitem 100 kont na komendę; przesunięcie pozwala na wyświetlenie kolejnych numerów kont.

Parametry

ParametrOpis
klientidentyfikator klienta
offsetprzesunięcie pozwalające na wyświetlenie kolejnych identyfikatorów

Zwracane dane

Zwracane daneOpis
maxilość certyfikatów na koncie klienta
certstablica identyfikatorów certyfikatów

Przykładowa komenda

listByClient(‚csa123’, 100)

$response = $soap->listByClient('csa123', 100);

Przykładowa odpowiedź

{"status":true,"max":"104","certs":["435345345435","456456355","6867856767","675686965577"]}

Komenda: info

Opis komendy

Komenda pozwala na uzyskanie informacji o certyfikacie

ParametrOpis
uniqueIdnumer sprawdzanego certyfikatu

Zwracane dane

ParametrOpis
domainnazwa domeny
certNamenazwa certyfikatu
crDatedata zarejestrowania
exDatedata ważności certyfikatu
clientnumer konta klienta
certAdmindane administratora certyfikatu (w przypadku braku ‚null’)
certOrgdane organizacji na która został zakupiony certyfikat (w przypadku braku ‚null’)

Przykładowa komenda

info(‚b343f2d12a38a7c4b23a038’)

$response = $soap->info('b343f2d12a38a7c4b23a038');

Przykładowa odpowiedź

{"status":true,"domain":"testowa.com","certName":"RapidSSL","crDate":"2012-02-12 22:49:54","exDate":"2015-02-15 23:59:59","client":"csa007","certAdmin":{"type":"admin","title":"Mr","firstName":"Jan","lastName":"Kowalski","organization":"Firma testowa","role":"Company Director","email":"admin@testowa.com","phoneCC":"+48","phoneAC":"123","phoneN":"123123","address1":"Testowa 1/2","address2":"","city":"Miasto","state":"mazowieckie","postCode":"01-123","country":"PL"},"certOrg":null}