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 artykuł zawiera informacje o następujących żądaniach:
- domains-list – lista domen na koncie klienta
- domain-check – sprawdzenie, czy domena jest dostępna
- domain-create – rejestracja nowej domeny
- domain-info – pobranie informacji o domenie
- domain-renew – odnowienie domeny
- domain-update-ns – zmiana serwerów DNS domeny
- domain-transfer-check – sprawdzenie możliwości transferu
- domain-transfer – transfer domeny od innego rejestratora
- domain-send-auth-info – wysłanie AUTH-ID domeny
- domain-update-keyset – edycja keyset domeny
- domain-tld-period-check – sprawdzenie dostępności okresu
domains-list
The domains-list żądanie zwraca listę wszystkich domen na koncie klienta wraz z ich statusem. Zwraca również nazwy usuniętych domen. Jeśli do domeny przypisano więcej niż jedno zamówienie, żądanie zwróci ją wielokrotnie z odpowiednim statusem (na przykład usunięta).
Parametry
- status – filtrowanie według statusu (opcjonalne)
Typowe stany domeny to:
- fee_waiting – oczekiwanie na płatność
- setup_processing – tworzenie w toku
- active
- renew_processing – odnowienie w toku
- expired
- disabled
- canceled
- transfer_fee_waiting – oczekiwanie na płatność za transfer
- transfer_processing – transfer od innego rejestratora w toku
- deleted
Wartości zwrotne
- 1000 – OK
Dane odpowiedzi
Polecenie domains-list zwraca listę domen, w której każda domena zawiera następujące pozycje:
- name – nazwa domeny
- status – status domeny
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domains-list",
"clTRID": "your ID",
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domains-list",
"data": {
"domain": {
"1": {
"name": "domain1.tld",
"status": "status"
},
"0": {
"name": "domain2.tld",
"status": "status"
}
}
}
}
}
domain-check
Użyj domain-check żądanie sprawdzenia, czy możemy zarejestrować domenę.
The domain-check żądanie podlega limitowi 100 zapytań o domeny na godzinę.
Niektórych domen nie możemy zarejestrować, mimo że obecnie nie istnieją. Nazwy mogą być zarezerwowane, zablokowane lub ich rejestracja może być ograniczona w inny sposób. Zawsze zależy to od konkretnego rejestru, jego zasad lub trwających sporów.
Parametry
- name – nazwa domeny bez www lub wiele domen oddzielonych przecinkami
Wartości zwrotne
- 1000 – domena jest dostępna do rejestracji lub żądanie zostało zwrócone (kod odpowiedzi dla żądania z wieloma domenami)
- 3201 – nazwa domeny jest już używana
- 3204 – domena jest w kwarantannie
- 3205 – domena jest zarezerwowana
- 3206 – nazwa domeny jest zablokowana
Dane odpowiedzi
- name – nazwa domeny
- code – wartość zwracana dla tej domeny, znajduje się w data tylko wtedy, gdy żądanie sprawdza wiele domen
- result – tekstowa wartość kodu odpowiedzi, znajduje się w data tylko wtedy, gdy żądanie sprawdza wiele domen
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-check",
"clTRID": "your ID",
"data": {
"name": "your domain without www, or multiple comma-separated domains"
}
}
}
Odpowiedź JSON dla pojedynczej domeny (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-check",
"data": {
"name": "your domain without www"
}
}
}
Odpowiedź JSON dla wielu domen (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-check"
"data":[
{
"name":"existing-domain.tld",
"code":3201,
"result":"Domain is registered"
},
{
"name":"free-domain.tld",
"code":1000,
"result":"OK"
}
]
}
}
}
domain-create
Użyj domain-create żądanie rejestracji nowej domeny. Żądanie jest synchroniczne albo asynchroniczne, w zależności od TLD domeny.
The domain-create żądanie podlega limitowi 100 zapytań o domeny na godzinę.
W przypadku wszystkich domen my oraz rejestr wymagamy zgody właściciela domeny na zasady rejestracji nazw domen. Nasz regulamin wymagają zapoznania Państwa klientów z naszym regulaminem oraz warunkami rejestratora domen! Niedopełnienie tego obowiązku może w razie sporu skutkować usunięciem domeny bez odszkodowania.
Parametry
- name – nazwa domeny wraz z TLD – wymagane
- period – liczba lat – wymagane
- dns lub nsset – lista serwerów DNS lub NSSET (tylko domeny CZ) – wymagane
- owner_c – ID kontaktu właściciela – wymagane
- admin_c – ID kontaktu administracyjnego – opcjonalne
- reguły – imię i nazwisko osoby, która zaakceptowała nasz regulamin oraz warunki rejestru (zwykle właściciel domeny)
Możliwe dns wartości parametru:
- Pusta wartość parametru dns – zostanie użyta wartość domyślna (serwery DNS WEDOS). Uwaga, nawet jeśli pozostawisz parametr DNS pusty, i tak trzeba go podać! Parametr NSSET musi zawsze zawierać wartość (np.
WEDOS). - Własna konfiguracja DNS – nie można używać dla domen CZ (każdy rekord musi zawierać name pole, opcjonalnie addr_ip4 i addr_ip6, poszczególne serwery są zagnieżdżone w elemencie server). Szczegóły znajdziesz w szablonie.
Wartości zwrotne
- 1000 – domena została pomyślnie zarejestrowana
- 1001 – asynchroniczne żądanie rejestracji przyjęte
- 3002 – niewystarczające środki na koncie zaliczkowym
- 3201 – nazwa domeny jest już używana
- 3204 – domena jest w kwarantannie
- 3205 – domena jest zarezerwowana
- 3206 – nazwa domeny jest zablokowana
- 2201 – nieobsługiwany TLD
- 2203 – nieprawidłowy okres
- 3221 – tworzenie nie powiodło się
- 4207 – tworzenie nie powiodło się – błąd połączenia
Dane odpowiedzi
Po pomyślnej rejestracji domeny w węźle data zwracane są następujące pozycje:
- num – numer zamówienia
- expiration – data wygaśnięcia domeny
- credit – stan konta zaliczkowego po zakończeniu operacji
- amount – saldo konta zaliczkowego
- currency – waluta
Szablony
Żądanie JSON z WEDOS NSSET:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-create",
"clTRID": "your ID",
"data": {
"name": "domain.cz",
"period": "number of years",
"nsset": "WEDOS",
"owner_c": "owner contact ID",
"admin_c": "admin contact ID",
"rules": {
"fname": "Name",
"lname": "Surname"
}
}
}
}
Żądanie JSON z własnym DNS:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-create",
"clTRID": "your ID",
"data": {
"name": "domain.tld",
"period": "number of years",
"dns": {
"server1":
{
"name": "ns1.dns-provider.tld"
},
"server2":
{
"name": "ns2.dns-provider.tld"
}
}
},
"owner_c": "domain owner contact ID",
"admin_c": "domain admin contact ID",
"rules": {
"fname": "Name",
"lname": "Surname"
}
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-create",
"data": {
"num": "order number",
"expiration": "YYYY-MM-DD"
}
}
}
domain-info
Użyj domain-info żądanie uzyskania informacji o konkretnej domenie.
Polecenie działa tylko dla domen na odpowiednim koncie klienta.
Parametry
- name – nazwa domeny, dla wielu domen należy użyć ciągu oddzielonego przecinkami (patrz szablon) – wymagane
Wartości zwrotne
- 1000 – polecenie wykonane pomyślnie, element data zawiera informacje o domenie
- 3222 – nie udało się pobrać obiektu domeny
- 3216 – nie udało się pobrać informacji o domenie
- 3223 – domena nie należy do Państwa konta klienta
- 4205 – błąd połączenia z rejestrem
Wartość zwrotna dla wielu domen zawsze wynosi 1000. Ewentualne wartości błędów są wyświetlane w danych domain , jak pokazano w szablonie.
Dane odpowiedzi
Element data zawiera informacje o domenie, jeśli operacja się powiedzie. Konkretne dane zależą od typu domeny i innych okoliczności. Oto najważniejsze z nich:
- name – nazwa domeny
- status – status domeny
- owner_c – ID właściciela domeny
- setup_date – data utworzenia
- expiration – data wygaśnięcia
- dns lub NSSET – lista serwerów DNS lub NSSET
- pozycje z own_ prefiks – informacje o właścicielu domeny
Część informacji o domenie lub jej właścicielu może być ukryta; wtedy mają wartość HIDDEN.
Szablony
Żądanie JSON z 2 domenami:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-info",
"clTRID": "your ID",
"data": {
"name": "domain.name1, domain.name2"
}
}
}
Odpowiedź JSON (domain.name1 OK, domain.name2 błąd):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-info",
"data": {
"domain": [{
"name": "domain.name1",
"status": "status",
"owner_c": "owner ID",
"nsset": "WEDOS",
"reg_owner": "",
"reg_creator": "",
"setup_date": "YYYY-MM-DD",
"expiration": "YYYY-MM-DD",
"reg_update": "",
"updated_date": "",
"transfer_date": "",
"dns": {
"server1":
{
"name": "ns1.server-provider.tld"
},
"server2":
{
"name": "ns1.server-provider.tld"
}
}
},
"own_company": "",
"own_name": "",
"own_lname": "",
"own_fname": "",
"own_email": "",
"own_email2": "",
"own_phone": "",
"own_fax": "",
"own_ic": "",
"own_dic": "",
"own_taxpayer": "",
"own_addr_street": "",
"own_addr_city": "",
"own_addr_zip": "",
"own_addr_country": "",
"own_addr_state": "",
"admin_c": "",
"own_other": {
"notify_email": "",
"ident_type": "",
"ident": ""
}
},
{
"name": "domain.name2",
"code": 3222,
"result": "Domain open failed"
}]
}
}
}
domain-renew
The domain-renew żądanie umożliwia odnowienie domeny, która nie ma jeszcze zamówionego odnowienia.
Domyślnie system automatycznie próbuje odnowić domeny 30 dni przed wygaśnięciem. To zachowanie możesz wyłączyć w ustawieniach konta ⧉.
Parametry
- name – nazwa domeny – wymagane
- period – liczba lat odnowienia – wymagane
Wartości zwrotne
- 1000 – domena została pomyślnie odnowiona
- 2203 – nieprawidłowy okres odnowienia
- 2269 – żądanie odnowienia już istnieje
Dane odpowiedzi
W razie powodzenia to polecenie zwraca nową datę wygaśnięcia.
- expiration – nowa data wygaśnięcia domeny
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-renew",
"clTRID": "your ID",
"data": {
"name": "your domain name without www",
"period": "number of years"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-renew",
"data": {
"expiration": "YYYY-MM-DD"
}
}
}
domain-update-ns
Użyj domain-update-ns żądanie zmiany serwerów DNS lub NSSET domeny.
Parametry
- name – nazwa domeny – wymagane
- dns lub nsset – serwery DNS lub NSSET dla domen CZ – wymagane
Możliwe dns wartości parametru:
- Pusta wartość parametru dns – zostanie użyta wartość domyślna (serwery DNS WEDOS). Uwaga, nawet jeśli pozostawisz parametr DNS pusty, i tak trzeba go podać! Parametr NSSET musi zawsze zawierać wartość (np.
WEDOS). - Własna konfiguracja DNS – nie można używać dla domen CZ (każdy rekord musi zawierać name pole, opcjonalnie addr_ip4 i addr_ip6, poszczególne serwery są zagnieżdżone w elemencie server). Szczegóły znajdziesz w szablonie.
Wartości zwrotne
- 1000 – serwery DNS zostały pomyślnie ustawione
- 2209 – nieprawidłowy format NSSET (dla domen CZ)
- 2210 – nieprawidłowy format serwera DNS
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-update-ns",
"clTRID": "your ID",
"data": {
"name": "domain.tld",
"dns": {
"server1":
{
"name": "ns1.own-dns-server.tld"
},
"server2":
{
"name": "ns1.own-dns-server.tld"
}
}
}
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-update-ns",
}
}
domain-transfer-check
Użyj domain-transfer-check żądanie sprawdzenia, czy domenę można przenieść od innego rejestratora do nas.
The domain-transfer-check żądanie podlega limitowi 100 zapytań o domeny na godzinę.
Parametry
- name – nazwa domeny bez www – wymagane
Wartości zwrotne
Żądanie zwraca zazwyczaj następujące wartości:
- 1000 – transfer jest możliwy
- 3217 – nie udało się nawiązać połączenia z rejestrem
- 3218 – transfer nie jest możliwy
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-transfer-check",
"clTRID": "your ID",
"data": {
"name": "domain.tld"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-transfer-check"
}
}
domain-transfer
Użyj domain-transfer żądanie przeniesienia domeny od innego rejestratora do WEDOS.
Żądanie jest synchroniczne tylko dla domen CZ i EU, czyli dla nich, jeśli AUTH-ID jest poprawne, transfer zostaje wykonany natychmiast i od razu znasz wynik. W przypadku innych domen transfery są asynchroniczne, więc wynik poznasz przez notyfikację.
The domain-transfer żądanie podlega limitowi 100 zapytań o domeny na godzinę.
W przypadku wszystkich domen my oraz rejestr wymagamy zgody właściciela domeny na zasady rejestracji nazw domen. Nasz regulamin wymagają zapoznania Państwa klientów z naszym regulaminem oraz warunkami rejestratora domen! Niedopełnienie tego obowiązku może w razie sporu skutkować usunięciem domeny bez odszkodowania.
Parametry
- name – nazwa domeny bez www – wymagane
- auth_info – AUTH-ID domeny – wymagane
- owner_c – ID właściciela domeny – wymagane tylko dla niektórych rejestrów (SK, EU, gTLD)
- dns – konfiguracja serwerów DNS domeny – opcjonalne; dostępne tylko dla rejestrów, które to obsługują (EU, gTLD)
- reguły – imię i nazwisko osoby, która zaakceptowała nasz regulamin oraz warunki rejestru (zwykle właściciel domeny) – wymagane
Dostępne wartości parametru dns parametr:
- Pominięty parametr DNS – domena zachowa bieżące ustawienia serwerów DNS. Podczas transferu bieżące serwery DNS zostaną rozpoznane. Jeśli rozpoznanie bieżących serwerów DNS nie będzie możliwe, transfer może zakończyć się błędem (gTLD).
- Pusty parametr DNS – system spróbuje ustawić domyślne serwery DNS WEDOS.
- Parametr DNS z serwerami – system spróbuje ustawić te serwery DNS.
Wartości zwrotne
- 1000 – domena została pomyślnie przeniesiona
- 1001 – żądanie transferu zostało przyjęte, oczekuje na realizację
- 2100 – brak wymaganego parametru
- 2101 – nieprawidłowa wartość parametru
- 2201 – nieprawidłowy TLD
- 2202 – nieprawidłowy format nazwy domeny
- 2204 – nie podano identyfikatora kontaktu właściciela domeny
- 2207 – nieprawidłowy identyfikator kontaktu właściciela domeny
- 2210 – nieprawidłowy format serwera DNS
- 2215 – nie podano AUTH-ID, a jest ono wymagane dla tej domeny
- 2245 – brak zgody
- 2246 – błąd danych zgody
- 2252 – przekroczono liczbę żądań dotyczących domen
- 2263 – AUTH-ID jest krótsze niż wymagana minimalna długość
- 2271 – nieprawidłowy format AUTH-ID
- 3001 – nieprawidłowa waluta konta zaliczkowego
- 3003 – nieprawidłowe dane rozliczeniowe konta zaliczkowego
- 3207 – domena jest już zarejestrowana u nas
- 3208 – transfer nie powiódł się z powodu problemu z datą wygaśnięcia
- 3217 – nie udało się nawiązać połączenia z rejestrem
- 3218 – transfer niemożliwy
- 3219 – dla tej domeny istnieje już oczekujące żądanie transferu
- 3220 – domena jest już zarejestrowana w naszym rejestrze
- 3226 – nie udało się przenieść domeny
- 3227 – błąd autoryzacji w rejestrze domen
- 3258 – przerwa w działaniu rejestru
- 3266 – nie można przenieść, ponieważ domena wygasła
- 3267 – nie udało się rozwiązać autorytatywnych serwerów DNS
- 4002 – nie udało się pobrać środków z konta zaliczkowego
- 4003 – nie udało się utworzyć okresu rozliczeniowego
- 4206 – nie udało się ustalić, czy domenę można przenieść – błąd połączenia
- 4209 – nie udało się ustalić typu transferu (z odnowieniem / bez odnowienia)
- 5001 – wewnętrzny błąd logowania
- 5002 – nie udało się obliczyć ceny transferu
- 5004 – przerwa w działaniu fakturacji
Dane odpowiedzi
- num – numer zamówienia
- expiration – data wygaśnięcia domeny
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-transfer",
"clTRID": "your ID",
"data": {
"name": "domain.tld",
"auth_info": "AUTH-ID",
"dns": {
"server1":
{
"name": "ns1.mydns.tld"
},
"server2":
{
"name": "ns2.mydns.tld"
}
}
},
"rules": {
"fname": "Name",
"lname": "Surname"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-transfer",
"data": {
"num": "order number",
"expiration": "YYYY-MM-DD"
}
}
}
domain-send-auth-info
Użyj domain-send-auth-info żądanie wysłania AUTH-ID domeny na adres e-mail właściciela domeny.
Parametry
- name – nazwa domeny – wymagane
Wartości zwrotne
- 1000 – AUTH-ID zostało wysłane na adres e-mail właściciela domeny
- 2243 – brak uprawnień do wysłania auth_info
- 3209 – nie udało się wysłać auth_info
- 3210 – nie udało się wysłać auth_info – domena jest niedostępna
- 3222 – nie udało się pobrać domeny
- 3223 – domena nie należy do tego konta klienta
- 4214 – nie udało się wysłać auth_info – błąd połączenia – proszę spróbować później
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-send-auth-info",
"clTRID": "your ID",
"data": {
"name": "domain.tld"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-send-auth-info"
}
}
domain-update-keyset
The domain-update-keyset żądanie umożliwia wprowadzanie zmian w ustawieniach KEYSET domeny, tj. włączenie, wyłączenie lub aktualizację ustawień DNSSEC.
Parametry
- name – nazwa domeny – wymagane
- keyset – ustawienia KEYSET – wymagane
0 = brak KEYSET / wyłączenie DNSSEC
1 = nasz KEYSET / nasz DNSSEC (jeśli domena korzysta z naszych serwerów DNS i jest ustawiona jako primary)
ciąg znaków = nazwa własnego KEYSET (jeśli domena nie korzysta z naszych serwerów DNS lub jest ustawiona jako secondary)
Wartości zwrotne
- 1000 = OK
- 2202 = nieprawidłowa lub nieobsługiwana nazwa istniejącej domeny
- 2264 = nieprawidłowa nazwa KEYSET
- 2265 = brak obsługi DNSSEC
- 2266 = nieobsługiwana akcja dla domeny secondary
- 2267 = nieobsługiwana akcja dla domeny primary
- 3260 = istnieje już oczekujące zamówienie DNSSEC
- 3258 = trwa przerwa w działaniu rejestru
- 3263 = domena nie korzysta z naszego DNS
- 3222 = nie udało się otworzyć domeny
- 3223 = odmowa dostępu
- 3259 = KEYSET jest niedostępny
- 3262 = Konfiguracja DNSSEC nie powiodła się
- 3264 = KEYSET jest zablokowany
Zwracane dane
Żądanie nie zwraca żadnych danych.
Szablony
Żądanie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-update-keyset",
"clTRID": "your ID",
"data": {
"name": "domain name",
"keyset": "0/1/string",
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-update-keyset"
}
}
domain-tld-period-check
Użyj domain-tld-period-check żądanie sprawdzenia, czy dla danego TLD można ustawić określony okres rejestracji.
Parametry
- tld – TLD
- period – liczba lat
Wartości zwrotne
- 1000 – okres może być użyty dla tej domeny
- 2203 –okres nie może być użyty dla tej domeny
Dane odpowiedzi
Żądanie nie zwraca żadnych danych.
Szablony
Polecenie JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-tld-period-check",
"clTRID": "your ID",
"data": {
"tld": "domain tld",
"period": "number of years"
}
}
}
Odpowiedź JSON (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-tld-period-check"
}
}