Modul Certificate

Komenda: generatePKEY

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

Zwracane dane

Zwracane dane Opis
pkey wygenerowany klucz prywatny

 

Przykładowa komenda
generatePKEY()

1
$response = $soap->generatePKEY();

Przykładowa odpowiedź:

1
{"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
organization Nazwa firmy
department (pole opcjonalne) wydział
commonName nazwa domeny do której będzie generowany certyfikat (dla wildcard musi się zaczynać od *.)
email adres email
state województwo
city miasto
country dwuliterowy kod kraju

Zwracane dane

Zwracane dane Opis
csr wygenerowane żądanie certyfikatu

Przykładowa komenda
generateCSR($pkey, $organization, $department, $commonName, $email, $state, $city, $country)

1
$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ź:

1
{"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 certyfikatu Nazwa Certyfikatu Dostępne odnowienie Dodatkowe pola org Dostępne okresy
2 RapidSSL tak 12, 24, 36
3 RapidSSL Wildcard tak 12, 24, 36
5 QuickSSL Basic tak 12, 24, 36
6 QuickSSL Premium tak 12, 24, 36
7 True BusinessID tak tak 12, 24, 36
8 True BusinessID Wildcard tak tak 12, 24, 36
9 True BusinessID + EV tak tak 12, 24
14 Secure Site tak tak 12, 24, 36
15 Secure Site Pro tak tak 12, 24, 36
16 Secure Site + EV tak tak 12, 24
17 Secure Site Pro + EV tak tak 12, 24
19 SSL123 tak tak 12, 24, 36

Parametry

 

Parametr Opis
certId nr certyfikatu
period okres w miesiącach zgodny z certyfikatem
email email 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
client Numer konta abonenckiego CSA, na którym ma zostać zarejestrowana domena
csr żądanie podpisania certyfikatu
Administrator certyfikatu
admTitle dostępne wartości („Mrs”, „Mr”, „Miss”, „Ms”, „Dr”)
admFirstName imię 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admLastName nazwisko 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admOrganization nazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admRole jedna z listy („Business Owner”, „Company Director”, „WebSite Owner”, „IT Department”, „Other”)
admEmail adres email
admPhoneCC numer kierunkowy kraju np. +48
admPhoneAC numer kierunkowy telefonu np. 22 lub 500
admPhoneN pozostały numer telefonu
admAddress1 adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
admCity miasto
admState województwo
admPostCode kod pocztowy
admCountry dwuliterowy kod kraju
Dane organizcji (wymagane tylko dla wyższych certyfikatów)
orgOrganization nazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
orgPhoneCC numer kierunkowy kraju np. +48
orgPhoneAC numer kierunkowy telefonu np. 22 lub 500
orgPhoneN pozostały numer telefonu
orgAddress1 adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
orgCity miasto
orgState województwo
orgPostCode kod pocztowy
orgCountry dwuliterowy kod kraju

Zwracane dane

 

 

 

Zwracane dane Opis
wnId Numer 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)

1
$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ź:

1
{"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

 

Parametr Opis
certId nr certyfikatu
period okres w miesiącach zgodny z certyfikatem
email email 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
client Numer konta abonenckiego CSA, na którym ma zostać zarejestrowana domena
csr żądanie podpisania certyfikatu
Administrator certyfikatu
admTitle dostępne wartości (Mrs, Mr, Miss, Ms, Dr)
admFirstName imię 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admLastName nazwisko 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admOrganization nazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
admRole jedna z listy („Business Owner”, „Company Director”, „WebSite Owner”, „IT Department”, „Other”)
admEmail adres email
admPhoneCC numer kierunkowy kraju np. +48
admPhoneAC numer kierunkowy telefonu np. 22 lub 500
admPhoneN pozostały numer telefonu
admAddress1 adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
admCity miasto
admState województwo
admPostCode kod pocztowy
admCountry dwuliterowy kod kraju
Dane organizcji (wymagane tylko dla wyższych certyfikatów)
orgOrganization nazwa firmy 2 – 40 znaków dozwolone znaki [A-Za-z0-9-_.’ ]
orgPhoneCC numer kierunkowy kraju np. +48
orgPhoneAC numer kierunkowy telefonu np. 22 lub 500
orgPhoneN pozostały numer telefonu
orgAddress1 adres zawierający (ulice, numer) dozwolone znaki [a-zA-Z0-9-,._ ]
orgCity miasto
orgState województwo
orgPostCode kod pocztowy
orgCountry dwuliterowy kod kraju

Zwracane dane

 

Zwracane dane Opis
wnId Numer 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)

1
$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ź:

1
{"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

 

Parametr Opis
offset przesunięcie pozwalające na wyświetlenie kolejnych identyfikatorów

 

Zwracane dane

 

Zwracane dane Opis
max ilość certyfikatów obsługiwanych przez Partnera
certs tablica identyfikatorów certyfikatów

 

Przykładowa komenda
listAll(100)

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

Przykładowa odpowiedź:

1
{"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

Parametr Opis
klient identyfikator klienta
offset przesunięcie pozwalające na wyświetlenie kolejnych identyfikatorów

 

Zwracane dane

 

Zwracane dane Opis
max ilość certyfikatów na koncie klienta
certs tablica identyfikatorów certyfikatów

 

Przykładowa komenda
listByClient(‚csa123’, 100)

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

Przykładowa odpowiedź:

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

Komenda: info

Opis komendy
Komenda pozwala na uzyskanie informacji o certyfikacie

Parametry

 

Parametr Opis
uniqueId numer sprawdzanego certyfikatu

 

Zwracane dane

Parametr Opis
domain nazwa domeny
certName nazwa certyfikatu
crDate data zarejestrowania
exDate data ważności certyfikatu
client numer konta klienta
certAdmin dane administratora certyfikatu (w przypadku braku ‚null’)
certOrg dane organizacji na która został zakupiony certyfikat (w przypadku braku ‚null’)

 

Przykładowa komenda
info(‚b343f2d12a38a7c4b23a038’)

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

Przykładowa odpowiedź:

1
{"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}