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

ParametrOpis
nazwa(y) domenNazwy domen oddzielone średnikami. Maksymalna ilość domen w jednej komendzie: 25

Zwracane dane

Zwracane daneOpis
statusStatus 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":{"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

ParametrOpis
domenaNazwa sprawdzanej domeny.

Zwracane dane

Zwracane daneOpis
domainNazwa domeny
crDateData utworzenia domeny
exDateData wygasania domeny
clientNumer konta CSA
protectPrivacyStatus ochrony prywatności (0 lub 1)
tradePwKod cesji domeny
dnsTablica serwerów nazw

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":"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

ParametrOpis
domenaNazwa domeny
numer CSANumer 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 DataDodatkowe 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

RozszerzenieNazwa parametruWartośćOpis wartości
.UScategoryC11Osoba fizyczna – obywatel USA
C12Osoba fizyczna, która jest stałym rezydentem USA lub terytorium należącego do USA.
C21Pół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).
C31Podmiot 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).
C32Jednostka, która ma siedzibę lub oddział na terenie USA.
purposeP1Zastosowania biznesowe dla zysku
P2Organizacja non-profit, klub, stowarzyszenie, organizacja religijna itp.
P3Użytek osobisty
P4Cele edukacyjne
P5Cele rządowe
.PROprofessionAcupuncturistsAkupunktura
Allied Health ProffesionalsFachowiec-tematyka związana ze zdrowiem
Ambulance ServicesPogotowie Ratunkowe
ArchitectsArchitekci
Asbestos Removal ProfessionalsFachowiec od usuwania azbestu
Barbers and Barber ShopsFryzjerzy, sklepy fryzjerskie
Certified Financial AnalystsCertyfikowany Analityk Finansowy
Certified Financial PlannersCertyfikowany Planista Finansowy
Certified PubliAccountantsCertyfikowany Księgowy
Check CashersKasjer
ChiropractorsKręgarz
Contractors, Home ImprovementPodwykonawcy, remonty domów
Cosmetologists and AestheticiansKosmetologia i estetyka
Debt CollectorsKomornicy
Dentists and Dental HygienistsDentyści i higieniści stomatologiczni
Dieticians and NutritionistsDietetycy i żywieniowcy
DoctorsDoktorzy
EducatorsWychowawcy
ElectriciansElektrycy
ElectrologistsFachowcy od elektrycznej depilacji ludzkich włosów
Emergency Medical TechnicianRatownicy medyczni
Engineers and Land SurveyorsInżynierowie i geodeci
Finance CompaniesFirmy finansowe
Financial ProfessionalDoradca Finansowy
Funeral ServicesSerwis pogrzebowy
Health CareOpieka medyczna
Hearing Instrument SpecialistsSpecjaliści od instrumentów
Home InspectorsKuratorzy
HVAC TechniciansSpecjalista ds. ogrzewania, klimatyzacji i systemów chłodniczych
InsuranceUbezpieczenia
Investment AdvisorsDoradcy inwestycyjni
Landscape ArchitectsArchitekci krajobrazu
LawyersPrawnicy
Lead Paint InspectorsInspektorzy ds. ołowiu lakierniczego
Manufactured Building ProducersProducenci materiałów budowlanych
Massage TherapyMasażyści
Money TransmittersPrzekazywanie pieniędzy
Mortgage Lenders and BrokersKredytodawcy hipoteczni i pośrednicy
Municipal Building InspectorsMiejscy inspektorzy budowlani
Nurses and Nurse AidesPielęgniarstwo i pomoc
Nursing Home AdministratorsAdministracja ds. pielęgniarstwa
NutritionistsDietetycy
OpticiansOpticians
OptometristsOptometryk
PerfusionistPerfuzjonista
PharmacistsFarmaceuta
Physical TherapistsFizjoterapeuta
Physician AssistantsAsystent lekarza
PhysiciansLekarze
Plumbers and Gas FittersInstalatorzy i monterzy gazu
PodiatristsPodiatrzy
PsychologistsPsycholodzy
PubliRelationsPubliRelations
Radio and TV TechniciansTechnicy – radio i telewizja
Real EstateReal Estate
Real Estate AppraisersRzeczoznawcy ds. nieruchomości
Respiratory TherapistsTerapeuci
SanitariansSanitariusze
Social WorkersPracownicy społeczni
Speech Pathologists and AudiologistsLogopedzi i audiolodzy
VeterinariansWeterynarze
Water Plant OperatorOperatorzy instalacji wodnych
X-Ray TechniciansTechnicy wykonujący Rentgen
Internet ProfessionalSpecjaliści ds. Internetu
Medical ProfessionalSpecjaliści medyczni
Legal ProfessionalSpecjaliści ds. prawnych
OtherInne
.ESlegalForm1Osoba fizyczna
39Ugrupowanie biznesowe
47Stowarzyszenie
59Stowarzyszenie ds. sportu
68Stowarzyszenie ds. handlu
124Bank oszczędnościowy
150Własność społeczna
152Kondominium
164Zakon lub instytucja
181Konsulat
197Stowarzyszenie Prawa Publicznego
203Ambasada
229Miasto
269Federacja sportowa
286Fundacja
365Towarzystwo Ubezpieczeń Wzajemnych
434Organ wojewódzki
436Organ rządowy
439Partia polityczna
476Związek zadowody
510Związek rolników
524Spółka/korporacja prawa publicznego
525Publiczna sp. z o.o. związana ze sportem
554Partnerstwo
560Partnerstwo na zasadach ogólnych
562Partnerstwo na ustalonych zasadach
566Spółdzielnia
608Firma będąca własnością pracowników
612Spółka z ograniczoną odpowiedzialnością
713Oddział firmy na terenie Hiszpanii
717Konsorcjum czasowe / Joint Venture
744Spółka z o.o. będąca własnością pracowników
746Jednostka rządowa
747Jednostka samorządowa
877Inna forma
878Oznaczenie pochodzenia regulacji
879Jednostka zarzadzająca terenem naturalnym
documentIdnumer identyfikacyjny abonenta (NIP/PESEL)
.CAtypeWartości dla osób fizycznych
CCTObywatel Kanady
RESStały Rezydent Kanady
ABORdzenny mieszkaniec Kanady
LGRPrawny opiekun Obywatela Kanady lub Stałego rezydenta
Wartości dla firm/organizacji
CCOOsoba prawna (Kanada/Prowincja Kanady/Terytorium Kanady)
GOVJednostka rządowa lub jednostka samorządu terytorialnego w Kanadzie
EDUKanadyjska instytucja edukacyjna
ASSKanadyjskie stowarzyszenie nie posiadające osobowości prawnej
HOPKanadyjski Szpital
PRTPrzedstawicielstwo zarejestrowane w Kanadzie
TDMNazwa handlowa zarejestrowana w Kanadzie (przez właściciela nie pochodzącego z Kanady)
TRDKanadyjski związek zawodowy
PLTKanadyjska partia polityczna
LAMKanadyjskia Biblioteka, Archiwum lub Muzeum
TRSTrust z siedzibą w Kanadzie
INBPlemię Indian prawnie uznane przez Kanadyjską Ustawę dotyczącą Indian
OMKOficjalna marka zarejestrowana w Kanadzie
MAJJej Królewska Mość
.ITentityType1Osoba fizyczna
7Firma/Organizacja nie znajdująca się we Włoszech
regCodenumer identyfikacyjny abonenta (NIP/PESEL)
.FRregistrantTypeindividualOsoba fizyczna
organizationFirma/Organizacja
countryOfBirthKraj urodzenia
dateOfBirthData urodzenia np. (1972-06-23)
placeOfBirthMiejsce urodzenia (tylko dla kraju FR)
postalCodeOfBirthKod pocztowy miejsca urodzenia (tylko dla kraju FR)

Zwracane dane

Zwracane daneOpis
id wnioskuNumer identyfikacyjny wniosku

Przykładowa komenda

register(„test12345.pl”, „csa1234”, 1, true, null)

register(„test12345.us”, „csa1106”, 1, true, null, „category=C11;purpose=P1”)

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

Przykładowa odpowiedź

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

ParametrOpis
domenaNazwa domeny, na której ma zostać oparty host
hostNazwa tworzonego hosta
adres IPAdres IP, który powinien zostać przypisany do nowotworzonego hosta

Zwracane dane

Zwracane daneOpis
statusStatus wykonania komendy – true lub false

Przykładowa komenda

createHost(„test.pl”,”dns.test.pl”,”123.123.123.123″)

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

Przykładowa odpowiedź

{"status":true}

Komenda: changeDns

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa domeny, dla której będzie zmieniana delegacja
serwery DNSNazwy serwerów DNS oddzielone średnikiem (opcjonalnie adres IP po znaku ‚=’)

Zwracane dane

Zwracane daneOpis
statusStatus 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”)

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

Przykładowa odpowiedź

{"status":true}

Komenda: renew

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa domeny, dla której ma zostać wygenerowany wniosek
Okres utrzymaniaOkres, 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 daneOpis
id wnioskuNumer identyfikacyjny wniosku

Przykładowa komenda

renew(„test.pl”, 1, ‚y’)

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

Przykładowa odpowiedź

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

Komenda: domainInSystem

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa sprawdzanej domeny

Zwracane dane

Zwracane daneOpis
domainInSystemInformacja, czy domena znajduje się w systemie (true lub false)

Przykładowa komenda

domainInSystem(„hrd.pl”)

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

Przykładowa odpowiedź

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

ParametrOpis
domenaNazwa domeny
AuthinfoWeryfikowany kod Authinfo

Zwracane dane

Zwracane daneOpis
validatePoprawność 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: validateTradePw

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa domeny
TradePwWeryfikowany kod cesji

Zwracane dane

Zwracane daneOpis
validatePoprawność kodu cesji – true lub false

Przykładowa komenda

validateTradePw(„hrd.pl”, „abcd”)

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

Przykładowa odpowiedź

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

Komenda: trade

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa cedowanej domeny
numer CSANumer konta abonenckiego CSA dla strony przejmującej domenę
TradePwKod cesji
PrivacyProtect[Parametr opcjonalny – domyślnie true tam, gdzie to możliwe] ochrona prywatności abonenta przejmującego domenę

Zwracane dane

Zwracane daneOpis
statusStatus wykonania komendy – true lub false

Przykładowa komenda

trade(„test.pl”, „csa1234”, „abcd”)

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

Przykładowa odpowiedź

{"status":true}

Komenda: tradeStatus

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa domeny, dla której zainicjowano e-cesję

Zwracane dane

Zwracane daneOpis
initDateData zainicjowania cesji
statusStatus cesji (patrz tabela Status cesji)
Dane zwracane zarówno dla strony zrzekającej (tablica „owner), jak i dla strony przejmującej (tablica „buyer”)
clientIdNumer konta CSA strony cesji
nameNazwa/imię i nazwisko strony cesji
emailadres email strony cesji, na który przesłane zostało potwierdzenie woli cesji
confirmDateData potwierdzenia operacji przez daną stronę cesji

Status cesji

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

Przykładowa komenda

tradeStatus(„testtestowy.pl”)

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

Przykładowa odpowiedź

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

ParametrOpis
domenaNazwa transferowanej domeny
numer CSANumer konta abonenckiego CSA, do którego będzie transferowana domena
AuthinfoKod 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 DataDodatkowe 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 daneOpis
wnIdNumer wniosku pozwalającego na aktywację transferu

Przykładowa komenda

transfer(„abcd.pl”, „csa123”, „agFGSAES23”, 1, true)

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

Przykładowa odpowiedź

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

Komenda: transferDelete

Opis komendy

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

Parametry

ParametrOpis
domenaNazwa transferowanej domeny
numer CSANumer konta abonenckiego CSA, na którym jest transferowana domena

Zwracane dane

Zwracane daneOpis
statusrue – jeśli się udało

Przykładowa komenda

transferDelete(„abcd.pl”, „csa123”)

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

Przykładowa odpowiedź

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

ParametrOpis
Numer CSAnumer konta abonenckiego CSA, dla którego wygenerowana zostanie lista domen
offsetprzesunięcie pozwalające na wyświetlenie kolejnych domen z konta klienta

Zwracane dane

Zwracane daneOpis
maxilość domen abonenta
domainstablica nazw domen oddzielonych przecinkami

Przykładowa komenda

listByClient(„csa1234”, 0)

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

Przykładowa odpowiedź

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

ParametrOpis
offsetprzesunięcie pozwalające na wyświetlenie kolejnych domen z konta klienta

Zwracane dane

Zwracane daneOpis
maxilość domen obsługiwanych przez Partnera
domainstablica nazw domen oddzielonych przecinkami

Przykładowa komenda

listAll(100)

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

Przykładowa odpowiedź

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

ParametrOpis
domainnazwa domeny dla której aktywowane ma być ukrywanie danych

Zwracane dane

Zwracane daneOpis
statustrue – jeśli się udało

Przykładowa komenda

privacyAddDomain(„abcd.pl”)

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

Przykładowa odpowiedź

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

ParametrOpis
domainnazwa domeny dla której nie ma być przedłużane/aktywowane ukrywanie danych

Zwracane dane

Zwracane daneOpis
statustrue – jeśli się udało

Przykładowa komenda

privacyRemoveDomain(„abcd.pl”)

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

Przykładowa odpowiedź

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

ParametrOpis
Domainnazwa domeny, dla której żadana jest zmiana danych w rejestrze domen globalnych

Zwracane dane

Zwracane daneOpis
statustrue – jeśli się udało

Przykładowa komenda

IRTPResend(„abcd.pl”)

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

Przykładowa odpowiedź

{"status":true}