Ten artykuł omawia polecenia WAPI dotyczące konkretnie usługi WEDOS DNS. Informacje o konfiguracji WAPI i rozwiązywaniu typowych problemów znajdziesz w artykule WAPI – podręcznik.
Ten poradnik dotyczy żądań WAPI do pracy z kontaktami domenowymi. Instrukcje dotyczące domen znajdziesz w WAPI – Domeny.
W tym artykule znajdą Państwo informacje o zarządzaniu kontaktami domen dla następujących obsługiwanych TLD:
a także dla następujących poleceń:
- contact-check – sprawdzenie dostępności kontaktu
- contact-info – lista informacji o kontakcie
- contact-create – utworzenie nowego kontaktu
- contact-update – edycja danych kontaktu
- contact-transfer – transfer kontaktu od innego rejestratora
- contact-send-auth-info – wysłanie AUTH-ID kontaktu
Kontakty domenowe w poszczególnych rejestrach
Każdy rejestr domen zarządza kontaktami inaczej, obowiązują różne zasady dotyczące identyfikatorów kontaktów, obowiązkowych pozycji w szczegółach itd.
Zwykle można ustawić tylko nazwę firmy oraz imię i nazwisko, tj. company, fname i lname parametry podczas tworzenia kontaktu, ponieważ rejestry traktują zmianę tych informacji jako równoznaczną ze zmianą właściciela. Bardziej szczegółowe informacje znajdują się poniżej.
Domeny CZ
Przy tworzeniu kontaktu dla domeny CZ można podać nazwę. Użyj contact-check aby sprawdzić, czy wybrana nazwa jest dostępna (nieużywana, niezablokowana, ..).
Nazwa kontaktu może zawierać wyłącznie wielkie litery alfabetu angielskiego, cyfry i myślnik. Jeśli przy tworzeniu kontaktu nie podasz nazwy, system wygeneruje ją automatycznie.
W szczegółach kontaktu mogą Państwo ustawić:
- cname – nazwa kontaktu (tylko przy tworzeniu nowego); pominięcie tego parametru lub pozostawienie go pustym spowoduje wygenerowanie pseudolosowej nazwy)
- company
- fname – imię – wymagane
- lname – nazwisko – wymagane
- email – wymagane
- phone – numer telefonu +XXX XXXXXXXXX
- fax – numer faksu +XXX XXXXXXXXX
- dic – numer VAT
- addr_street – ulica i numer domu – wymagane
- addr_city – miejscowość – wymagane
- addr_zip – kod pocztowy – wymagane
- addr_country – kraj (dwuliterowy kod ISO, małymi literami) – wymagane
- addr_state – województwo lub region
- ident_type – typ dokumentu tożsamości (ico (ID firmy), op (dowód osobisty), birthday (data urodzenia w formacie DD.MM.YYYY), passport, mpsv (ID MPSV))
- ident – numer dokumentu tożsamości (w zależności od ident_type)
- notify_email – adres e-mail do notyfikacji
- disclose_phone – ukrycie telefonu
- disclose_fax – ukrycie faksu
- disclose_email – ukrycie e-maila
- disclose_ident – ukrycie numeru dokumentu tożsamości
- disclose_notify_email – ukrycie e-maila do notyfikacji
W kontaktach domen CZ można ukryć niektóre pozycje szczegółów kontaktu. Użyj disclose_* wpisy w szczegółach kontaktu z flagą 0/1 (1 = ukryte, 0 = publiczne) określające, czy dana informacja ma być ukryta. Jeśli informacja jest oznaczona jako ukryta, nie można jej wyświetlić bez autoryzacji.
Od połowy stycznia 2018 możesz ustawić adres dostawy dla kontaktów domen CZ. Przy tworzeniu/edycji kontaktu wprowadź następujące pozycje:
- del_addr=1 – aktualny adres dostawy (wymagane)
- del_addr_street1 – ulica (wymagane)
- del_addr_street2 – ulica (opcjonalne)
- del_addr_street3 – ulica (opcjonalne)
- del_addr_city – miasto (wymagane)
- del_addr_state – województwo lub region
- del_addr_country – kraj (dwuliterowy kod ISO, małymi literami) (wymagane)
Aby dezaktywować adres doręczeń dla kontaktu, wpisz del_addr=0 podczas tworzenia/edycji kontaktu.
Domeny EU
Przy tworzeniu kontaktu w rejestrze EURid nie można podać jego name. System zawsze przydziela go automatycznie.
W szczegółach kontaktu mogą Państwo ustawić:
- company
- fname – imię – wymagane
- lname – nazwisko – wymagane
- email – wymagane
- phone – numer telefonu +XXX XXXXXXXXX
- fax – numer faksu +XXX XXXXXXXXX
- dic – numer VAT
- addr_street – ulica i numer domu – wymagane
- addr_city – miejscowość – wymagane
- addr_zip – kod pocztowy – wymagane
- addr_country – kraj (dwuliterowy kod ISO, małymi literami) – wymagane
- addr_state – województwo lub region
Domeny SK
Przy tworzeniu kontaktu dla domeny SK można podać nazwę. Użyj contact-check aby sprawdzić, czy wybrana nazwa jest dostępna (nieużywana, niezablokowana, ..).
Nazwa kontaktu może zawierać wyłącznie wielkie litery alfabetu angielskiego, cyfry, myślniki i kropki. Minimalna długość nazwy kontaktu to 5 znaków, maksymalna 16 znaków. Jeśli przy tworzeniu kontaktu nie podasz nazwy, system wygeneruje ją automatycznie. Format automatycznie wygenerowanej nazwy kontaktu to WEDOS-XXX-YYYY (gdzie XXX to kombinacja liter i cyfr, a YYYY to wyłącznie cyfry).
W szczegółach kontaktu mogą Państwo ustawić:
- cname – nazwa kontaktu (tylko przy tworzeniu nowego); pominięcie tego parametru lub pozostawienie go pustym spowoduje wygenerowanie pseudolosowej nazwy)
- company
- fname – imię – wymagane
- lname – nazwisko – wymagane
- email – wymagane
- phone – numer telefonu +XXX XXXXXXXXX
- fax – numer faksu +XXX XXXXXXXXX
- dic – numer VAT
- addr_street – ulica i numer domu – wymagane
- addr_city – miejscowość – wymagane
- addr_zip – kod pocztowy – wymagane
- addr_country – kraj (dwuliterowy kod ISO, małymi literami) – wymagane
- addr_state – województwo lub region
- ident_type – typ podmiotu, można ustawić tylko raz (PERS = osoba fizyczna, CORP = firma)
- ident – wartość identyfikacyjna (PERS = data urodzenia w formacie RRRR-MM-DD, CORP = identyfikator firmy)
- disclose_name – ukrycie imienia
- disclose_org – ukrycie nazwy firmy
- disclose_addr – ukrycie adresu
- disclose_phone – ukrycie telefonu
- disclose_fax – ukrycie faksu
- disclose_email – ukrycie adresu e-mail
Domeny PL
Przy tworzeniu kontaktu PL nie można podać jego name. System zawsze przydziela go automatycznie.
W szczegółach kontaktu mogą Państwo ustawić:
- company
- fname – imię, nie można zmienić dla legal_type = individual – wymagane
- lname – nazwisko, nie można zmienić dla legal_type = individual – wymagane
- email – wymagane
- phone – numer telefonu +XXX XXXXXXXXX
- fax – numer faksu +XXX XXXXXXXXX
- dic – numer VAT
- addr_street – ulica i numer domu – wymagane
- addr_city – miejscowość – wymagane
- addr_zip – kod pocztowy – wymagane
- addr_country – kraj (dwuliterowy kod ISO, małymi literami) – wymagane
- addr_state – województwo lub region
- legal_type – typ prawny (company, individual), nie można zmienić – wymagane
Domeny gTLD i nTLD
Przy tworzeniu kontaktu dla domen gTLD i nTLD nie można podać jego nazwy, system tworzy ją automatycznie.
W szczegółach kontaktu mogą Państwo ustawić:
- company
- fname – imię – wymagane
- lname – nazwisko – wymagane
- email – wymagane
- phone – numer telefonu +XXX XXXXXXXXX
- fax – numer faksu +XXX XXXXXXXXX
- dic – numer VAT
- addr_street – ulica i numer domu – wymagane
- addr_city – miejscowość – wymagane
- addr_zip – kod pocztowy – wymagane
- addr_country – kraj (dwuliterowy kod ISO, małymi literami) – wymagane
- addr_state – województwo lub region
contact-check
Użyj contact-check żądanie sprawdzenia dostępności nazwy kontaktu.
Parametry
- tld – TLD, dla którego tworzony jest kontakt (np. eu)
- cname – nazwa kontaktu
Wartości zwrotne
- 1000 – kontakt jest wolny i można go użyć
- 2201 – nieprawidłowy TLD
- 2216 – nieprawidłowy format kontaktu
- 2218 – nazwa jest generowana automatycznie (dla niektórych TLD nie można podać nazwy kontaktu)
- 3231 – kontakt już istnieje
- 3233 – kontaktu nie można użyć
- 3234 – kontaktu nie można użyć – w kwarantannie
- 3235 – kontaktu nie można użyć – zarezerwowany
- 3236 – kontaktu nie można użyć – zablokowany
- 4211 – weryfikacja nie powiodła się – błąd komunikacji, proszę powtórzyć polecenie później
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-check",
"clTRID": "your ID",
"data": {
"tld": "tld",
"cname": "contact id"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "contact-check"
}
}
contact-info
The contact-info polecenie zwraca szczegółowe informacje o kontakcie.
Domeny CZ używają systemu AUTH-ID, które służą do odkrywania ukrytych pozycji kontaktu. Każdy może wykonać contact-info dla dowolnego istniejącego kontaktu, ale ukryte informacje pojawiają się tylko po przekazaniu prawidłowego AUTH-ID. System zapisuje twórcę kontaktu lub osobę, która podała prawidłowy AUTH-ID, i udostępnia jej te informacje bez konieczności ponownego przekazywania AUTH-ID.
Parametry
- tld – TLD – wymagane
- cname – nazwa kontaktu – wymagana
- auth_info – AUTH-ID kontaktu – opcjonalne (jeśli domena to obsługuje, podanie AUTH-ID ujawni ukryte dane kontaktu)
- reg_key – ID rejestru – opcjonalne
Wartości zwrotne
- 1000 – informacje o kontakcie pobrane pomyślnie
- 2201 – nieprawidłowy TLD
- 2216 – nieprawidłowa składnia kontaktu
- 3215 – wysłanie auth info kontaktu nie powiodło się
- 3228 – nieobsługiwana wartość
- 3229 – błąd wczytywania kontaktu
- 3236 – kontakt zablokowany
- 4212 – błąd połączenia
- 5001 – brak zalogowania
Dane odpowiedzi
W razie powodzenia (kod 1000) polecenie zwraca informacje o kontakcie w węźle contact.
Szablony
Żądanie JSON (kontakt CZ.NIC):
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-info",
"clTRID": "your ID",
"data": {
"tld": "cz",
"cname": "contact-id",
"auth_info": "auth-info-string",
"reg_key": "cznic",
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "contact-info",
"data": {
"contact": {
"contact_id": "contact id",
"status": "status",
"name": "name and surname",
"company": "company",
"addr_street": "street and number",
"addr_city": "city",
"addr_zip": "zip code",
"addr_state": "state or region",
"addr_country": "country iso code",
"phone": "full phone number",
"email": "email",
"fax": "full fax number",
"reg_owner": "",
"reg_creator": "",
"reg_update": "",
"created_date": "YYYY-MM-DD hh:mm:ss",
"updated_date": "YYYY-MM-DD hh:mm:ss",
"transfer_date": "YYYY-MM-DD hh:mm:ss",
"fname": "name",
"lname": "surname",
"email2": "",
"ic": "company id",
"dic": "vat id",
"taxpayer": "",
"disclose": "",
"other": {
"notify_email": "",
"ident_type": "",
"ident": ""
}
}
}
}
}
Odpowiedź JSON (nie znaleziono kontaktu):
{
"response":
{
"code":3215,
"result":"Contact send auth info failed",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command":"contact-info"
}
}
contact-create
Użyj contact-create żądanie utworzenia nowego kontaktu, którego można używać z domenami zarejestrowanymi w odpowiednim rejestrze. Każdy kontakt jest identyfikowany przez swoją nazwę, która jest zawsze unikalna. Więcej informacji o pracy z kontaktami w poszczególnych rejestrach znajdą Państwo w rozdziale Kontakty domenowe w poszczególnych rejestrach.
Parametry
- tld – TLD domeny
- contact – tablica pozycji kontaktu:
- cname – nazwa kontaktu (puste = generowanie automatyczne)
- fname – imię
- lname – nazwisko
- company – firma
- addr_street – ulica i numer domu
- addr_city – miasto
- addr_zip – kod pocztowy
- addr_state – województwo lub region
- addr_country – kraj (dwuliterowy kod ISO, małymi literami)
- phone
- fax
- inne pozycje w zależności od rejestru
Wartości zwrotne
- 1000 = kontakt został pomyślnie utworzony
- 2201 = nieprawidłowy tld
- 2216 = nieprawidłowa nazwa kontaktu
- 2218 = nazwa kontaktu jest tworzona automatycznie
- 2219 = nie podano pozycji firma
- 2220 = nie podano nazwy pozycji
- 2221 = nie podano nazwiska
- 2222 = nie podano email
- 2223 = nieprawidłowy format email
- 2224 = nie podano email2
- 2225 = nieprawidłowy format email2
- 2226 = nie podano telefonu
- 2227 = nieprawidłowy format telefonu
- 2228 = nie podano faksu
- 2229 = nieprawidłowy format faksu
- 2230 = nie podano identyfikatora firmy
- 2231 = nieprawidłowy format identyfikatora firmy
- 2232 = Nie podano numeru VAT
- 2233 = Nieprawidłowy format numeru VAT
- 2234 = nie podano ulicy
- 2235 = nie podano miejscowości
- 2236 = Nie podano kodu pocztowego
- 2237 = nie podano kraju
- 2238 = nieprawidłowy format kraju
- 2239 = nie podano województwa
- 2240 = nie podano pozostałych danych
- 2241 = nieprawidłowy format pozostałych danych
- 3228 = domena nie pracuje z kontaktami
- 3230 = nie udało się utworzyć kontaktu
- 3231 = nazwa kontaktu jest już używana
- 3232 = kontaktu nie można użyć – przyczyna nieznana
- 3233 = kontaktu nie można użyć
- 3234 = kontaktu nie można użyć – w kwarantannie
- 3235 = kontaktu nie można użyć – zarezerwowany
- 3236 = kontaktu nie można użyć – zablokowany
- 3237 = kontakt jest już u nas zarejestrowany
- 4211 = nie udało się sprawdzić kontaktu – błąd komunikacji
- 4213 = nie udało się utworzyć kontaktu – błąd komunikacji
Dane odpowiedzi
Kontakt zwraca następujące dane:
- cname – nazwa utworzonego kontaktu
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-create",
"clTRID": "your ID",
"data": {
"tld": "cz",
"contact": {
"fname": "name",
"lname": "surname",
"email": "email",
"addr_street": "street and number",
"addr_city": "city",
"addr_zip": "zip code",
"addr_country": "country ISO code",
"phone": "full phone number",
"notify_email": "notification email"
}
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "contact-create",
"data": {
"cname": "contact id"
}
}
}
contact-update
Użyj contact-update żądanie edycji wpisów kontaktu.
Zawsze podawaj wszystkie parametry kontaktu, nie tylko te, które chcesz zaktualizować.
Więcej informacji o pracy z kontaktami w poszczególnych rejestrach znajdziesz w rozdziale Kontakty domenowe w poszczególnych rejestrach.
Autoryzuj wszystkie zmiany, podając AUTH-ID (auth_info) jeśli nie masz autoryzacji ustawionej bezpośrednio dla swojego konta klienckiego (dzieje się tak po pierwszym pomyślnym użyciu AUTH-ID lub gdy kontakt jest tworzony w naszym systemie).
Parametry
- tld – TLD
- cname – nazwa kontaktu
- auth_info – AUTH-ID
- contact – pozycje kontaktu
- fname – imię
- lname – nazwisko
- company
- addr_street – ulica i numer
- addr_city – miasto
- addr_zip – kod pocztowy
- addr_state – województwo lub region
- addr_country – kraj (dwuliterowy kod ISO, małymi literami)
- phone
- fax
- inne pozycje zgodnie z rejestrem
Wartości zwrotne
- 1000 = OK
- 2201 = nieprawidłowy TLD
- 2207 = błąd składni w nazwie kontaktu
- 2216 = nieprawidłowa nazwa kontaktu
- 2219 = nie podano pozycji firma
- 2220 = nie podano pozycji imię
- 2221 = nie podano pozycji nazwisko
- 2222 = nie podano pozycji email
- 2223 = nieprawidłowy format pozycji email
- 2224 = nie podano pozycji email2
- 2225 = nieprawidłowy format pozycji email2
- 2226 = nie podano pozycji telefon
- 2227 = nieprawidłowy format pozycji telefon
- 2228 = nie podano pozycji faks
- 2229 = nieprawidłowy format pozycji faks
- 2230 = nie podano pozycji identyfikator firmy
- 2231 = nieprawidłowy format pozycji identyfikator firmy
- 2232 = nie podano pozycji numer VAT
- 2233 = nieprawidłowy format pozycji numer VAT
- 2234 = nie podano pozycji ulica
- 2235 = nie podano pozycji miasto
- 2236 = nie podano pozycji kod pocztowy
- 2237 = nie podano pozycji kraj
- 2238 = nieprawidłowy format pozycji kraj
- 2239 = nie podano pozycji województwo
- 2240 = nie podano pozycji pozostałe dane
- 2241 = nieprawidłowy format pozycji pozostałe dane
- 3211 = błąd – nie udało się pobrać kontaktu
- 3238 = błąd autoryzacji
- 3239 = operacja nie powiodła się
- 4202 = niedostępny kontakt – błąd połączenia, spróbuj ponownie później
- 4215 = realizacja nie powiodła się – błąd połączenia, spróbuj ponownie później
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Polecenie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-update",
"clTRID": "your ID",
"data": {
"tld": "cz",
"contact": {
"fname": "name",
"lname": "surname",
"email": "email",
"addr_street": "street and number",
"addr_city": "city",
"addr_zip": "zip code",
"addr_country": "country ISO code",
"phone": "full phone number",
"notify_email": "email"
}
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "contact-update",
}
}
contact-transfer
Użyj contact-transfer żądanie przeniesienia kontaktu od innego rejestratora do WEDOS.
Transfer obsługują wyłącznie kontakty domen CZ.
Parametry
- tld – TLD
- cname – nazwa kontaktu
- auth_info – AUTH-ID
Wartości zwrotne
- 1000 = OK
- 2201 = nieprawidłowy TLD
- 2215 = brakujący parametr auth_info
- 2216 = nieprawidłowy identyfikator kontaktu
- 2244 = Ta domena nie obsługuje transferu kontaktu
- 3229 = kontakt jest niedostępny
- 3237 = kontakt jest już u nas zarejestrowany
- 3240 = błąd autoryzacji
- 3241 = transfer nie powiódł się
- 4216 = niepowodzenie – błąd połączenia
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-transfer",
"clTRID": "your ID",
"data": {
"tld": "cz",
"cname": "contact id",
"auth_info": "auth-id"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "contact-transfer",
}
}
contact-send-auth-info
Użyj contact-send-auth-info żądanie wysłania e-maila z AUTH-ID kontaktu.
Parametry
- tld – TLD
- cname – nazwa kontaktu
Wartości zwrotne
- 1000 = OK
- 2201 = nieprawidłowy TLD
- 2216 = nieprawidłowa nazwa kontaktu
- 2243 = wysyłanie auth_info nie jest dozwolone
- 3213 = kontakt jest niedostępny
- 3215 = nie udało się wysłać auth-id
- 3228 = kontakt nie jest obsługiwany dla tej domeny
- 4217 = wysyłanie nie powiodło się – błąd komunikacji
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-send-auth-info",
"clTRID": "your ID",
"data": {
"tld": "tld",
"cname": "contact id",
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "contact-send-auth-info",
}
}