Modul Domain

Komenda: check

Opis komendy
Komenda pozwala na sprawdzanie dostępności wybranej domeny/domen. 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 Domain.
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’)

1
2
$domains = array('hrd.pl', 'testhrd.net.pl', 'hrd123.com', 'ąśźżć.waw.pl', 'zła domena');
$response = $soap->check(implode(';', $domains));

Przykładowa odpowiedź:

1
{"status":true,"domains":{"zła domena":{"status":false,"error":"Bad domain name"},"hrd.pl":{"status":"0"},"testhrd.net.pl":{"status":"1"},"xn--2dae5wiek.waw.pl":{"status":"1"},"hrd123.com":{"status":"0"}}}

Komenda: info

Opis komendy
Komenda pozwala na sprawdzanie dostępnych w bazie informacji na temat nazwy domeny.

Parametry

 

Parametr Opis
domena Nazwa sprawdzanej domeny.

 

Zwracane dane

 

Zwracane dane Opis
domain Nazwa domeny
crDate Data utworzenia domeny
exDate Data wygasania domeny
client Numer konta CSA
protectPrivacy Status ochrony prywatności (0 lub 1)
tradePw Kod cesji domeny
dns Tablica serwerów nazw

 

Przykładowa komenda
info(‚test.pl’)

1
$response = $soap->info('test.pl');

Przykładowa odpowiedź:

1
{"status":true,"domain":"test.pl","crDate":"2012-10-09 14:18:11","exDate":"2013-10-09 14:18:11","client":"csa123","protectPrivacy":null,"tradePw":"abcdefg","dns":[{"nsName":"ns1.consultingservice.pl","nsIp":[]},{"nsName":"ns2.consultingservice.pl","nsIp":[]}]}

Komenda: register

Opis komendy
Komenda pozwala na wygenerowanie wniosku rejestracji dla wybranej nazwy domeny.
Komenda powinna być wykonana po sprawdzeniu dostępności domeny za pomocą komendy check modułu Domain.
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 domena.
period [Parametr opcjonalny – domyślnie 1] okres rejestracji domeny w latach.
ProtectPrivacy [Parametr opcjonalny – domyślnie true o ile Rejestr udostępnia taką możliwość] Ochrona prywatności true lub false. W przypadku domen globalnych wymagane jest dodatkowo wykorzystanie komendy privacyAddDomain przed komendą register
dns [Parametr opcjonalny – domyślnie przypisywane są serwery DNS Partnera] lista serwerów nazw oddzielonych średnikami.
additional Data Dodatkowe informacje (niezbędne dla wybranych rozszerzeń, patrz tabela: Additional Data). Parametry powinny być podawane w formie „[nazwa parametru]=[wartość parametru]”, np. „profession=insurance”.
W przypadku kilku parametrów należy oddzielić je średnikiem (np. „category=C11;purpose=P1”).

Additional Data

 

Rozszerzenie Nazwa parametru Wartość Opis wartości
.US category C11 Osoba fizyczna – obywatel USA
C12 Osoba fizyczna, która jest stałym rezydentem USA lub terytorium należącego do USA.
C21 Północnoamerykańska organizacja lub firma (amerykańska organizacja lub spółka utworzona w jednym z 50 stanów, dystrykcie Kolumbia, lub w którymkolwiek z amerykańskich posiadłości lub terytoriów, lub w inny sposób zorganizowana organizacja/firma, utworzona zgodnie z prawem USA, dystryktu Kolumbia lub zgodnie z prawem amerykańskiej posiadłości/terytorium lub jednostka rządowa, jednostka samorządowa lub jednostka podziału politycznego).
C31 Podmiot zagraniczny lub organizacja (podmiot zagraniczny lub organizacja, która posiada legalne przedstawicielstwo w USA/na terenie posiadłości USA/na terytorium należącym do USA, która regularnie prowadzi dozwoloną prawem działalność np. sprzedaż towarów, usług lub inny biznes, sprawy handlowe/nie handlowe, w tym działalność non-profit).
C32 Jednostka, która ma siedzibę lub oddział na terenie USA.
purpose P1 Zastosowania biznesowe dla zysku
P2 Organizacja non-profit, klub, stowarzyszenie, organizacja religijna itp.
P3 Użytek osobisty
P4 Cele edukacyjne
P5 Cele rządowe
.PRO profession Acupuncturists Akupunktura
Allied Health Professionals Fachowiec-tematyka związana ze zdrowiem
Ambulance Services Pogotowie Ratunkowe
Architects Architekci
Asbestos Removal Professionals Fachowiec od usuwania azbestu
Barbers and Barber Shops Fryzjerzy, sklepy fryzjerskie
Certified Financial Analysts Certyfikowany Analityk Finansowy
Certified Financial Planners Certyfikowany Planista Finansowy
Certified PubliAccountants Certyfikowany Księgowy
Check Cashers Kasjer
Chiropractors Kręgarz
Contractors, Home Improvement Podwykonawcy, remonty domów
Cosmetologists and Aestheticians Kosmetologia i estetyka
Debt Collectors Komornicy
Dentists and Dental Hygienists Dentyści i higieniści stomatologiczni
Dieticians and Nutritionists Dietetycy i żywieniowcy
Doctors Doktorzy
Educators Wychowawcy
Electricians Elektrycy
Electrologists Fachowcy od elektrycznej depilacji ludzkich włosów
Emergency Medical Technician Ratownicy medyczni
Engineers and Land Surveyors Inżynierowie i geodeci
Finance Companies Firmy finansowe
Financial Professional Doradca Finansowy
Funeral Services Serwis pogrzebowy
Health Care Opieka medyczna
Hearing Instrument Specialists Specjaliści od instrumentów
Home Inspectors Kuratorzy
HVAC Technicians Specjalista ds. ogrzewania, klimatyzacji i systemów chłodniczych
Insurance Ubezpieczenia
Investment Advisors Doradcy inwestycyjni
Landscape Architects Architekci krajobrazu
Lawyers Prawnicy
Lead Paint Inspectors Inspektorzy ds. ołowiu lakierniczego
Manufactured Building Producers Producenci materiałów budowlanych
Massage Therapy Masażyści
Money Transmitters Przekazywanie pieniędzy
Mortgage Lenders and Brokers Kredytodawcy hipoteczni i pośrednicy
Municipal Building Inspectors Miejscy inspektorzy budowlani
Nurses and Nurse Aides Pielęgniarstwo i pomoc
Nursing Home Administrators Administracja ds. pielęgniarstwa
Nutritionists Dietetycy
Opticians Opticians
Optometrists Optometryk
Perfusionist Perfuzjonista
Pharmacists Farmaceuta
Physical Therapists Fizjoterapeuta
Physician Assistants Asystent lekarza
Physicians Lekarze
Plumbers and Gas Fitters Instalatorzy i monterzy gazu
Podiatrists Podiatrzy
Psychologists Psycholodzy
PubliRelations PubliRelations
Radio and TV Technicians Technicy – radio i telewizja
Real Estate Real Estate
Real Estate Appraisers Rzeczoznawcy ds. nieruchomości
Respiratory Therapists Terapeuci
Sanitarians Sanitariusze
Social Workers Pracownicy społeczni
Speech Pathologists and Audiologists Logopedzi i audiolodzy
Veterinarians Weterynarze
Water Plant Operator Operatorzy instalacji wodnych
X-Ray Technicians Technicy wykonujący Rentgen
Internet Professional Specjaliści ds. Internetu
Medical Professional Specjaliści medyczni
Legal Professional Specjaliści ds. prawnych
Other Inne
.ES legalForm 1 Osoba fizyczna
39 Ugrupowanie biznesowe
47 Stowarzyszenie
59 Stowarzyszenie ds. sportu
68 Stowarzyszenie ds. handlu
124 Bank oszczędnościowy
150 Własność społeczna
152 Kondominium
164 Zakon lub instytucja
181 Konsulat
197 Stowarzyszenie Prawa Publicznego
203 Ambasada
229 Miasto
269 Federacja sportowa
286 Fundacja
365 Towarzystwo Ubezpieczeń Wzajemnych
434 Organ wojewódzki
436 Organ rządowy
439 Partia polityczna
476 Związek zadowody
510 Związek rolników
524 Spółka/korporacja prawa publicznego
525 Publiczna sp. z o.o. związana ze sportem
554 Partnerstwo
560 Partnerstwo na zasadach ogólnych
562 Partnerstwo na ustalonych zasadach
566 Spółdzielnia
608 Firma będąca własnością pracowników
612 Spółka z ograniczoną odpowiedzialnością
713 Oddział firmy na terenie Hiszpanii
717 Konsorcjum czasowe / Joint Venture
744 Spółka z o.o. będąca własnością pracowników
746 Jednostka rządowa
747 Jednostka samorządowa
877 Inna forma
878 Oznaczenie pochodzenia regulacji
879 Jednostka zarzadzająca terenem naturalnym
documentId numer identyfikacyjny abonenta (NIP/PESEL)
.CA type Wartości dla osób fizycznych
CCT Obywatel Kanady
RES Stały Rezydent Kanady
ABO Rdzenny mieszkanieKanady
LGR Prawny opiekun Obywatela Kanady lub Stałego rezydenta
Wartości dla firm/organizacji
CCO Osoba prawna (Kanada/Prowincja Kanady/Terytorium Kanady)
GOV Jednostka rządowa lub jednostka samorządu terytorialnego w Kanadzie
EDU Kanadyjska instytucja edukacyjna
ASS Kanadyjskie stowarzyszenie nie posiadające osobowości prawnej
HOP Kanadyjski Szpital
PRT Przedstawicielstwo zarejestrowane w Kanadzie
TDM Nazwa handlowa zarejestrowana w Kanadzie (przez właściciela nie pochodzącego z Kanady)
TRD Kanadyjski związek zawodowy
PLT Kanadyjska partia polityczna
LAM Kanadyjskia Biblioteka, Archiwum lub Muzeum
TRS Trust z siedzibą w Kanadzie
INB Plemię Indian prawnie uznane przez Kanadyjską Ustawę dotyczącą Indian
OMK Oficjalna marka zarejestrowana w Kanadzie
MAJ Jej Królewska Mość
.IT entityType 1 Osoba fizyczna
7 Firma/Organizacja nie znajdująca się we Włoszech
regCode numer identyfikacyjny abonenta (NIP/PESEL)
.FR registrantType individual Osoba fizyczna
organization Firma/Organizacja
countryOfBirth Kraj urodzenia
dateOfBirth Data urodzenia np. (1972-06-23)
placeOfBirth Miejsce urodzenia (tylko dla kraju FR)
postalCodeOfBirth Kod pocztowy miejsca urodzenia (tylko dla kraju FR)

 

Zwracane dane

 

Zwracane dane Opis
id wniosku Numer identyfikacyjny wniosku

 

Przykładowa komenda
register(„test12345.pl”, „csa1234”, 1, true, null)
register(„test12345.us”, „csa1106”, 1, true, null, „category=C11;purpose=P1”)

1
$response = $soap->register("test12345.pl", "csa1234", 1, true, null);

Przykładowa odpowiedź:

1
{"status":true,"wnId":"12345678"}

Komenda: createHost

Opis komendy
Komenda pozwala na tworzenie hosta we własnej domenie. Działa dla domen .pl oraz domen globalnych.

Parametry

Parametr Opis
domena Nazwa domeny, na której ma zostać oparty host
host Nazwa tworzonego hosta
adres IP Adres IP, który powinien zostać przypisany do nowotworzonego hosta

 

Zwracane dane

 

Zwracane dane Opis
status Status wykonania komendy – true lub false

 

Przykładowa komenda
createHost(„test.pl”,”dns.test.pl”,”123.123.123.123″)

1
$response = $soap->createHost("test.pl","dns.test.pl","123.123.123.123");

Przykładowa odpowiedź:

1
{"status":true}

Komenda: changeDns

Opis komendy
Komenda pozwala na zmianę serwerów nazw przypisanych do domeny poprzez zastąpienie dotychczasowych serwerów DNS.

Parametry

 

Parametr Opis
domena Nazwa domeny, dla której będzie zmieniana delegacja
serwery DNS Nazwy serwerów DNS oddzielone średnikiem (opcjonalnie adres IP po znaku ‚=’)

 

Zwracane dane

 

Zwracane dane Opis
status Status wykonania komendy – true lub false

 

Przykładowa komenda
changeDns(„test.pl”, „ns1.consultingservice.pl;ns2.consultingservice.pl”)
changeDns(„test.pl”, „ns1.consultingservice.pl=195.128.154.154;ns2.consultingservice.pl”)

1
$response = $soap->changeDns("test.pl", "ns1.consultingservice.pl;ns2.consultingservice.pl");

Przykładowa odpowiedź:

1
{"status":true}

Komenda: renew

Opis komendy
Komenda pozwala na wygenerowanie wniosku na odnowienie domeny w okresie abonamentowym.

Parametry

 

Parametr Opis
domena Nazwa domeny, dla której ma zostać wygenerowany wniosek
Okres utrzymania Okres, na jaki ma zostać odnowiona domena
Jednostka czasu [Parametr opcjonalny – domyślnie y – rok] dla domen .pl możliwe jest również podanie okresu odnowienia w dniach (d)

 

Zwracane dane

 

Zwracane dane Opis
id wniosku Numer identyfikacyjny wniosku

 

Przykładowa komenda
renew(„test.pl”, 1, ‚y’)

1
$response = $soap->renew("test.pl", 1, 'y');

Przykładowa odpowiedź:

1
{"status":true,"wnId":"12308804"}

Komenda: domainInSystem

Opis komendy
Komenda pozwala na sprawdzenie, czy dana domena znajduje się w HRD.

Parametry

 

Parametr Opis
domena Nazwa sprawdzanej domeny

 

Zwracane dane

 

Zwracane dane Opis
domainInSystem Informacja, czy domena znajduje się w systemie (true lub false)

 

Przykładowa komenda
domainInSystem(„hrd.pl”)

1
$response = $soap->domainInSystem("hrd.pl");

Przykładowa odpowiedź:

1
{"status":true,"domainInSystem":true}

Komenda: validateAuthInfo

Opis komendy
Komenda pozwala na sprawdzenie poprawności kodu Authinfo podanego przez inny Rejestr przed zainicjowaniem transferu do systemu HRD.pl.
Komenda działa jedynie dla domen .pl oraz .eu – komenda nie działa dla domen globalnych oraz ccTLD ze względu na ograniczenia techniczne dostawców tych rozszerzeń.
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”)

1
$response = $soap->validateAuthInfo("hrd.pl", "abcd");

Przykładowa odpowiedź:

1
{"status":true,"validate":true}

Komenda: validateTradePw

Opis komendy
Komenda pozwala na sprawdzenie poprawności kodu cesji przed zainicjowaniem e-cesji w obrębie systemu HRD.pl.

Parametry

 

Parametr Opis
domena Nazwa domeny
TradePw Weryfikowany kod cesji

 

Zwracane dane

 

Zwracane dane Opis
validate Poprawność kodu cesji – true lub false

 

Przykładowa komenda
validateTradePw(„hrd.pl”, „abcd”)

1
$response = $soap->validateTradePw("hrd.pl", "abcd");

Przykładowa odpowiedź:

1
{"status":true,"validate":true}

Komenda: trade

Opis komendy
Komenda pozwala na zainicjowanie e-cesji pomiędzy Abonentami w obrębie systemu HRD.pl.

Parametry

 

Parametr Opis
domena Nazwa cedowanej domeny
numer CSA Numer konta abonenckiego CSA dla strony przejmującej domenę
TradePw Kod cesji
PrivacyProtect [Parametr opcjonalny – domyślnie true tam, gdzie to możliwe] ochrona prywatności abonenta przejmującego domenę

 

Zwracane dane

 

Zwracane dane Opis
status Status wykonania komendy – true lub false

 

Przykładowa komenda
trade(„test.pl”, „csa1234”, „abcd”)

1
$response = $soap->trade("test.pl", "csa1234", "abcd");

Przykładowa odpowiedź:

1
{"status":true}

Komenda: tradeStatus

Opis komendy
Komenda pozwala na sprawdzenie danych stron cesji oraz statusu zainicjowanej cesji.
Dane zwracane są w tablicy „tradeList”.

Parametry

 

Parametr Opis
domena Nazwa domeny, dla której zainicjowano e-cesję

 

Zwracane dane

 

Zwracane dane Opis
initDate Data zainicjowania cesji
status Status cesji (patrz tabela Status cesji)
Dane zwracane zarówno dla strony zrzekającej (tablica „owner), jak i dla strony przejmującej (tablica „buyer”)
clientId Numer konta CSA strony cesji
name Nazwa/imię i nazwisko strony cesji
email adres email strony cesji, na który przesłane zostało potwierdzenie woli cesji
confirmDate Data potwierdzenia operacji przez daną stronę cesji

 

Status cesji

 

Status Opis
1 Cesja trwająca
2 Cesja przeprowadzona
3 Cesja anulowana
4 Cesja wygasła

 

Przykładowa komenda
tradeStatus(„testtestowy.pl”)

1
$response = $soap->tradeStatus("testtestowy.pl");

Przykładowa odpowiedź:

1
{"status":true,"tradeList":[{"owner":{"clientId":"csa269426","name":"Test testowy","email":"testtestowy@hrd.pl", "confirmDate":""},"buyer":{"clientId":"csa266275","name":"Testowy przejmujący","email":"testprzejmujacy@hrd.pl", "confirmDate":"2012-10-24 00:00:00"},"initDate":"2012-10-23 16:10:12","status":"2"}]}

Komenda: transfer

Opis komendy
Komenda pozwala na wygenerowanie wniosku transferu domeny 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 Domain.

Parametry

 

Parametr Opis
domena Nazwa transferowanej domeny
numer CSA Numer konta abonenckiego CSA, do którego będzie transferowana domena
Authinfo Kod Authinfo
Period [Parametr opcjonalny – domyślnie 1] okres, na który ma zostać odnowiona w procesie transferu. Dla domen .pl należy podać 0.
PrivacyProtect [Parametr opcjonalny – domyślnie true tam, gdzie to możliwe] ochrona prywatności abonenta przejmującego domenę. W przypadku domen globalnych wymagane jest dodatkowo wykorzystanie komendy privacyAddDomain przed komendą register
additional Data Dodatkowe informacje (niezbędne dla wybranych rozszerzeń, patrz tabela: Additional Data). Parametry powinny być podawane w formie „[nazwa parametru]=[wartość parametru]”, np. „profession=insurance”.
W przypadku kilku parametrów należy oddzielić je średnikiem (np. „category=C11;purpose=P1”).

 

Zwracane dane

 

Zwracane dane Opis
wnId Numer wniosku pozwalającego na aktywację transferu

 

Przykładowa komenda
transfer(„abcd.pl”, „csa123”, „agFGSAES23”, 1, true)

1
$response = $soap->transfer("abcd.pl", "csa123", "agFGSAES23", 1,  true);

Przykładowa odpowiedź:

1
{"status":true,"wnId":"12308851"}

Komenda: transferDelete

Opis komendy
Komenda pozwala na skasowanie żądania transferu z systemu HRD.pl.

Parametry

 

Parametr Opis
domena Nazwa transferowanej domeny
numer CSA Numer konta abonenckiego CSA, na którym jest transferowana domena

 

Zwracane dane

 

Zwracane dane Opis
status true – jeśli się udało

 

Przykładowa komenda
transferDelete(„abcd.pl”, „csa123”)

1
$response = $soap->transferDelete("abcd.pl", "csa123");

Przykładowa odpowiedź:

1
{"status":true}

Komenda: listByClient

Opis komendy
Komenda zwraca listę 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
domains tablica nazw domen oddzielonych przecinkami

 

Przykładowa komenda
listByClient(„csa1234”, 0)

1
$response = $soap->listByClient("csa1234", 0);

Przykładowa odpowiedź:

1
{"status":true,"max":"3","domains":["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
domains tablica nazw domen oddzielonych przecinkami

 

Przykładowa komenda
listAll(100)

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

Przykładowa odpowiedź:

1
{"status":true,"max":"103","domains":["stopierwszadomena.pl","stodrugadomena.pl","stotrzeciadomena.pl"]}

Komenda: privacyAddDomain

Opis komendy
Funkcja służy do dodawania domeny do listy domen dla których automatycznie jest aktywowane privacy protection w sytuacji ich rejestracji lub odnowienia.

Parametry

Parametr Opis
domain nazwa domeny dla której aktywowane ma być ukrywanie danych

Zwracane dane

Zwracane dane Opis
status true – jeśli się udało

Przykładowa komenda
privacyAddDomain(„abcd.pl”)

1
$response = $soap->privacyAddDomain("abcd.pl");

Przykładowa odpowiedź:

1
{"status":true}

Komenda: privacyRemoveDomain

Opis komendy
Funkcja służy do usuwania domeny z listy domen dla których automatycznie jest aktywowane privacy protection w sytuacji ich rejestracji lub odnowienia, poprzez jej wcześniejsze dodanie funkcją privacyAddDomain.

Parametry

Parametr Opis
domain nazwa domeny dla której nie ma być przedłużane/aktywowane ukrywanie danych

Zwracane dane

Zwracane dane Opis
status true – jeśli się udało

Przykładowa komenda
privacyRemoveDomain(„abcd.pl”)

1
$response = $soap->privacyRemoveDomain("abcd.pl");

Przykładowa odpowiedź:

1
{"status":true}

Komenda: IRTPResend

Opis komendy
Funkcja służy do ponownej wysyłki e-mail do Abonenta z linkiem do weryfikacji zmiany danych w rejestrze domen globalnych

Parametry

Parametr Opis
Domain nazwa domeny, dla której żadana jest zmiana danych w rejestrze domen globalnych

Zwracane dane

Zwracane dane Opis
status true – jeśli się udało

Przykładowa komenda
IRTPResend("abcd.pl")

1
$response = $soap->IRTPResend("abcd.pl");

Przykładowa odpowiedź:

1
{"status":true}