Komenda: check
Opis komendy
Komenda pozwala na sprawdzanie dostępności opcji na wybraną domenę/domeny. Zwraca w odpowiedzi status dla każdej z domen: dostępna/niedostępna.
Jeżeli domena jest dostępna można wygenerować wniosek jej rejestracji za pomocą komendy register modułu Future.
Parametry
Parametr | Opis |
---|---|
nazwa(y) domen | Nazwy domen oddzielone średnikami. Maksymalna ilość domen w jednej komendzie: 25 |
Zwracane dane
Zwracane dane | Opis |
---|---|
status | Status dostępności domeny 0 (niedostępna) lub 1 (dostępna) |
Przykładowa komenda
check(‚hrd.pl’, ‚testhrd.net.pl’, ‚hrd123.com’, ‚ąśźżć.waw.pl’, ‚zła domena’)
$domains = array('hrd.pl', 'testhrd.net.pl', 'hrd123.com', 'ąśźżć.waw.pl', 'zła domena'); $response = $soap->check(implode(';', $domains));
Przykładowa odpowiedź
{"status":true,"domains":{"hrd123.com":{"status":false,"errorCode":"1008","error":"Invalid domain name"},"z\u0142a domena":{"status":false,"errorCode":"1008","error":"Invalid domain name"},"hrd.pl":{"status":"1"},"testhrd.net.pl":{"status":"0"},"xn--2dae5wiek.waw.pl":{"status":"0"}}}
Komenda: info
Opis komendy
Komenda pozwala na sprawdzanie dostępnych w bazie informacji na temat opcji na nazwy domeny.
Parametry
Parametr | Opis |
---|---|
domena | Nazwa sprawdzanej opcji na domenę. |
Zwracane dane
Zwracane dane | Opis |
---|---|
domain | Nazwa domeny |
crDate | Data utworzenia domeny |
exDate | Data wygasania domeny |
client | Numer konta CSA |
contacts | Dane identyfikatora kontaktu |
Przykładowa komenda
info(‚test.pl’)
$response = $soap->info('test.pl');
Przykładowa odpowiedź
{"status":true,"domain":"test.pl","crDate":"2012-10-09 14:18:11","exDate":"2015-10-09 14:18:11","client":"csa123","protectPrivacy":null}
Komenda: register
Opis komendy
Komenda pozwala na wygenerowanie wniosku rejestracji opcji dla wybranej nazwy domeny. Komenda powinna być wykonana po sprawdzeniu dostępności domeny za pomocą komendy check modułu Future.
Aktywacja wniosku następuje poprzez komendę activateById modułu Invoice.
Parametry
Parametr | Opis |
---|---|
domena | Nazwa domeny |
numer CSA | Numer konta abonenckiego CSA, na którym ma zostać zarejestrowana opcja na domenę. |
dns | [Parametr opcjonalny – domyślnie przypisywane są serwery DNS Partnera] lista serwerów nazw oddzielonych średnikami. |
Zwracane dane
Zwracane dane | Opis |
---|---|
id wniosku | Numer identyfikacyjny wniosku |
Przykładowa komenda
register(„test12345.pl”, „csa1234”)
register(„test12345.us”, „csa1106”, „ns1.consultingservice.pl;ns2.consultingservice.pl”)
$response = $soap->register("test12345.pl", "csa1234");
Przykładowa odpowiedź
{"status":true,"wnId":"12345678"}
Komenda: renew
Opis komendy
Komenda pozwala na wygenerowanie wniosku na odnowienie opcji na domenę w okresie abonamentowym. Opcje można odnowić tylko na 3 lata.
Parametry
Parametr | Opis |
---|---|
domena | Nazwa opcji na domenę, dla której ma zostać wygenerowany wniosek |
Zwracane dane
Zwracane dane | Opis |
---|---|
id wniosku | Numer identyfikacyjny wniosku |
Przykładowa komenda
renew(„test.pl”)
$response = $soap->renew("test.pl");
Przykładowa odpowiedź
{"status":true,"wnId":"12308804"}
Komenda: validateAuthInfo
Opis komendy
Komenda pozwala na sprawdzenie poprawności kodu Authinfo podanego przez inny Rejestr przed zainicjowaniem transferu do systemu HRD.pl.
W przypadku, jeżeli kod Authinfo jest niepoprawny, Abonent powinien zwrócić się do Rejestratora z prośbą o wydanie poprawnego kodu.
Parametry
Parametr | Opis |
---|---|
domena | Nazwa domeny |
Authinfo | Weryfikowany kod Authinfo |
Zwracane dane
Zwracane dane | Opis |
---|---|
validate | Poprawność kodu Authinfo – true lub false |
Przykładowa komenda
validateAuthInfo(„hrd.pl”, „abcd”)
$response = $soap->validateAuthInfo("hrd.pl", "abcd");
Przykładowa odpowiedź
{"status":true,"validate":true}
Komenda: transfer
Opis komendy
Komenda pozwala na wygenerowanie wniosku transferu opcji na domenę do systemu HRD.pl. Dla domen .pl generowane są wnioski na kwotę 0 zł, aby ujednolicić procedurę transferu.
Aktywacja wniosku następuje poprzez komendę activateById modułu Invoice.
Przed inicjacją transferu warto sprawdzić poprawność kodu Authinfo za pomocą komendy validateAuthinfo modułu Future.
Parametry
Parametr | Opis |
---|---|
domena | Nazwa transferowanej domeny |
numer CSA | Numer konta abonenckiego CSA, do którego będzie transferowana domena |
Authinfo | Kod Authinfo |
Zwracane dane
Zwracane dane | Opis |
---|---|
wnId | Numer wniosku pozwalającego na aktywację transferu |
Przykładowa komenda
transfer(„abcd.pl”, „csa123”, „agFGSAES23”)
$response = $soap->transfer("abcd.pl", "csa123", "agFGSAES23");
Przykładowa odpowiedź
{"status":true,"wnId":"12308851"}
Komenda: listByClient
Opis komendy
Komenda zwraca listę opcji domen klienta z limitem 100 domen na komendę; przesunięcie pozwala na wyświetlenie kolejnych domen z konta klienta.
Parametry
Parametr | Opis |
---|---|
Numer CSA | numer konta abonenckiego CSA, dla którego wygenerowana zostanie lista domen. |
offset | przesunięcie pozwalające na wyświetlenie kolejnych domen z konta klienta |
Zwracane dane
Zwracane dane | Opis |
---|---|
max | ilość domen abonenta |
futures | tablica nazw domen oddzielonych przecinkami |
Przykładowa komenda
listByClient(„csa1234”, 0)
$response = $soap->listByClient("csa1234", 0);
Przykładowa odpowiedź
{"status":true,"max":"3","futures":["pierwszadomena.pl","drugadomena.pl","trzeciadomena.pl"]}
Komenda: listAll
Opis komendy
Komenda zwraca listę domen obsługiwanych przez Partnera z limitem 100 domen na komendę; przesunięcie pozwala na wyświetlenie kolejnych domen z konta.
Parametry
Parametr | Opis |
---|---|
offset | przesunięcie pozwalające na wyświetlenie kolejnych domen z konta klienta |
Zwracane dane
Zwracane dane | Opis |
---|---|
max | ilość domen obsługiwanych przez Partnera |
futures | tablica nazw domen oddzielonych przecinkami |
Przykładowa komenda
listAll(100)
$response = $soap->listAll(100);
Przykładowa odpowiedź
{"status":true,"max":"103","futures":["stopierwszadomena.pl","stodrugadomena.pl","stotrzeciadomena.pl"]}