Tento článek se zabývá příkazy WAPI konkrétně pro službu WEDOS DNS. Informace o nastavení WAPI a řešení běžných problémů naleznete v článku WAPI - manuál.
Tento výukový kurz se zabývá požadavky WAPI pro práci s kontakty domény. Pokyny k doménám najdete v části WAPI - Domény.
V tomto článku naleznete informace o správě kontaktů domén s následujícími podporovanými doménami nejvyšší úrovně:
a také na následujících příkazech:
- contact-check - zkontrolovat dostupnost kontaktů
- contact-info - seznam kontaktních informací
- contact-create - vytvoření nového kontaktu
- contact-update - editace kontaktních údajů
- contact-transfer - přenos kontaktu od jiného registrátora
- contact-send-auth-info - odeslání AUTH-ID kontaktu
Kontakty na domény podle jednotlivých registrů
Každý registr domén spravuje kontakty jinak, existují různá pravidla pro identifikátory kontaktů, povinné položky v detailech apod.
Při vytváření kontaktu lze obvykle nastavit pouze název společnosti, jméno a příjmení, tj. parametry company, fname a lname, protože registry považují změnu těchto údajů za rovnocennou změně vlastníka. Konkrétnější informace naleznete níže.
CZ domény
Při vytváření kontaktu pro doménu CZ můžete zadat jméno. Pomocí funkce kontakt-kontrola můžete zkontrolovat, zda je zvolené jméno k dispozici (nepoužívá se, je blokováno, ..).
Jméno kontaktu může obsahovat pouze velká písmena anglické abecedy, číslice a pomlčku. Pokud při vytváření kontaktu název nezadáte, systém jej vygeneruje automaticky.
V detailu kontaktu můžete nastavit:
- cname - jméno kontaktu (pouze při vytváření nového kontaktu); tento parametr vynechte nebo nechte prázdný, abyste vygenerovali pseudonáhodné jméno)
- společnost
- fname - jméno - povinné
- lname - příjmení - povinné
- e-mail - povinný
- telefon - telefonní číslo +XXX XXXXXXXXXXX
- fax - číslo faxu +XXX XXXXXXXXX
- dic - DIČ
- addr_street - adresa ulice a číslo domu - povinný údaj
- addr_city - adresa města - povinný údaj
- addr_zip - Poštovní směrovací číslo - povinné
- addr_country - země (dvoupísmenný kód ISO, malá písmena) - povinné
- addr_state - stát nebo oblast
- ident_type - typ dokladu totožnosti (ico (ID společnosti), op (osobní ID), narozeniny (datum narození ve formátu DD.MM.RRRR), pas, mpsv (ID MPSV)).
- ident - číslo dokladu ID (v závislosti na ident_type)
- notify_email - e-mailová adresa pro oznámení
- disclose_phone - skrýt telefon
- disclose_fax - skrýt fax
- disclose_email - skrýt e-mail
- disclose_ident - skrýt číslo dokladu ID
- disclose_notify_email - skrýt oznamovací e-mail
U kontaktů v doméně CZ je možné některé položky v podrobnostech kontaktu skrýt. Pomocí položek disclose_* v detailu kontaktu s příznakem 0/1 (1 = skrytý, 0 = veřejný) určete, zda má být daná informace skryta. Pokud je tato informace označena jako skrytá, nelze ji zobrazit bez autorizace.
Od poloviny ledna 2018 můžete nastavit doručovací adresu pro kontakty v doméně CZ. Při vytváření/úpravě kontaktu zadejte následující položky:
- del_addr=1 - adresa pro doručení acive (povinné)
- del_addr_street1 - ulice (povinné)
- del_addr_street2 - ulice (nepovinné)
- del_addr_street3 - ulice (nepovinné)
- del_addr_city - město (povinné)
- del_addr_state - stát nebo oblast
- del_addr_country - země (dvoupísmenný kód ISO, malá písmena) (povinné)
Chcete-li deaktivovat doručovací adresu pro kontakt, zadejte. del_addr=0
při vytváření/úpravě kontaktu.
Domény EU
Při vytváření kontaktu v registru EURid nelze zadat jeho název. Systém jej vždy přiřadí automaticky.
V detailu kontaktu můžete nastavit:
- společnost
- fname - jméno - povinné
- lname - příjmení - povinné
- e-mail - povinný
- telefon - telefonní číslo +XXX XXXXXXXXXXX
- fax - číslo faxu +XXX XXXXXXXXX
- dic - DIČ
- addr_street - adresa ulice a číslo domu - povinný údaj
- addr_city - adresa města - povinný údaj
- addr_zip - Poštovní směrovací číslo - povinné
- addr_country - země (dvoupísmenný kód ISO, malá písmena) - povinné
- addr_state - stát nebo oblast
Domény SK
Při vytváření kontaktu pro doménu SK můžete zadat název. Pomocí funkce contact-check zkontrolujte, zda je zvolené jméno k dispozici (nepoužívá se, je blokováno, ..).
Jméno kontaktu může obsahovat pouze velká písmena anglické abecedy, číslice, pomlčky a tečky. Minimální délka názvu kontaktu je 5 znaků, maximální délka je 16 znaků. Pokud při vytváření kontaktu název nezadáte, systém jej vygeneruje automaticky. Formát automaticky generovaného názvu kontaktu je WEDOS-XXX-YYYY (kde XXX je kombinace písmen a číslic a YYYY jsou pouze číslice).
V detailu kontaktu můžete nastavit:
- cname - jméno kontaktu (pouze při vytváření nového kontaktu); tento parametr vynechte nebo nechte prázdný, abyste vygenerovali pseudonáhodné jméno)
- společnost
- fname - jméno - povinné
- lname - příjmení - povinné
- e-mail - povinný
- telefon - telefonní číslo +XXX XXXXXXXXXXX
- fax - číslo faxu +XXX XXXXXXXXX
- dic - DIČ
- addr_street - adresa ulice a číslo domu - povinný údaj
- addr_city - adresa města - povinný údaj
- addr_zip - Poštovní směrovací číslo - povinné
- addr_country - země (dvoupísmenný kód ISO, malá písmena) - povinné
- addr_state - stát nebo oblast
- ident_type - typ subjektu, lze nastavit pouze jednou(PERS = fyzická osoba, CORP = společnost).
- ident - identifikační hodnota(PERS = datum narození ve formátu RRRR-MM-DD, CORP = ID společnosti)
- disclose_name - skrýt jméno
- disclose_org - skrýt název společnosti
- disclose_addr - skrytí adresy
- disclose_phone - skrýt telefon
- disclose_fax - skrýt fax
- disclose_email - skrýt e-mailovou adresu
PL domény
Při vytváření kontaktu PL nelze zadat jeho název. Systém jej vždy přiřadí automaticky.
V detailu kontaktu můžete nastavit:
- společnost
- fname - jméno, nelze změnit pro legal_type = individual - povinné
- lname - příjmení, nelze změnit pro legal_type = individual - povinné
- e-mail - povinný
- telefon - telefonní číslo +XXX XXXXXXXXXXX
- fax - číslo faxu +XXX XXXXXXXXX
- dic - DIČ
- addr_street - adresa ulice a číslo domu - povinný údaj
- addr_city - adresa města - povinný údaj
- addr_zip - Poštovní směrovací číslo - povinné
- addr_country - země (dvoupísmenný kód ISO, malá písmena) - povinné
- addr_state - stát nebo oblast
- legal_type - právní typ (společnost, fyzická osoba), nelze měnit - povinný údaj
Domény gTLD a nTLD
Při vytváření kontaktu pro domény gTLD a nTLD nelze zadat jeho název, systém jej vytvoří automaticky.
V detailu kontaktu můžete nastavit:
- společnost
- fname - jméno - povinné
- lname - příjmení - povinné
- e-mail - povinný
- telefon - telefonní číslo +XXX XXXXXXXXXXX
- fax - číslo faxu +XXX XXXXXXXXX
- dic - DIČ
- addr_street - adresa ulice a číslo domu - povinný údaj
- addr_city - adresa města - povinný údaj
- addr_zip - Poštovní směrovací číslo - povinné
- addr_country - země (dvoupísmenný kód ISO, malá písmena) - povinné
- addr_state - stát nebo oblast
kontakt-kontrola
Pomocí požadavku na kontrolu kontaktu můžete ověřit dostupnost jména kontaktu.
Parametry
- tld - TLD, pro kterou se má kontakt vytvořit (např. eu)
- cname - jméno kontaktu
Návratové hodnoty
- 1000 - kontakt je zdarma a lze jej použít
- 2201 - neplatná TLD
- 2216 - neplatný formát kontaktu
- 2218 - jméno se generuje automaticky (u některých TLD nelze zadat jméno kontaktu)
- 3231 - kontakt již existuje
- 3233 - kontakt nelze použít
- 3234 - kontakt nelze použít - v karanténě
- 3235 - kontakt nelze použít - vyhrazeno
- 3236 - kontakt nelze použít - zablokováno
- 4211 - ověření se nezdařilo - chyba komunikace, příkaz opakujte později
Údaje o odezvě
Požadavek nevrací žádná data.
Šablony
Požadavek JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-check",
"clTRID": "your ID",
"data": {
"tld": "tld",
"cname": "contact id"
}
}
}
Odpověď JSON (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "contact-check" } }
kontakt-info
Příkaz contact-info vrací podrobné informace o kontaktu.
CZ domény používají systém AUTH-ID, který slouží k odhalení skrytých položek v kontaktu. Kdokoli může vytvořit kontakt-info pro jakýkoli existující kontakt, ale skryté informace se zobrazí pouze v případě, že je předáno platné AUTH-ID. Systém zaznamenává tvůrce kontaktu, resp. toho, kdo zadal platné AUTH-ID, a zpřístupňuje mu informace bez nutnosti opakovaného předávání AUTH-ID.
Parametry
- tld - TLD
- cname - jméno kontaktu
- auth_info - AUTH-ID kontaktu - nepovinné (pokud to doména podporuje, zadání AUTH-ID odhalí skryté údaje kontaktu).
Návratové hodnoty
- 1000 - kontakt Informace byly úspěšně přijaty
- 2201 - neplatná TLD
- 2216 - neplatná syntaxe kontaktu
- 3228 - nepodporovaná hodnota
- 3229 - chyba při načítání kontaktu
- 4212 - chyba připojení
Údaje o odezvě
Pokud je příkaz úspěšný (kód 1000), vrátí informace o kontaktu v uzlu kontaktu.
Šablony
Požadavek JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-info",
"clTRID": "your ID",
"data": {
"tld": "cz",
"cname": "contact id"
}
}
}
Odpověď 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": "" } } } } }
vytvořit kontakt
Pomocí požadavku na vytvoření kontaktu vytvoříte nový kontakt, který můžete používat s doménami registrovanými v příslušném registru. Každý kontakt je identifikován svým názvem, který je vždy jedinečný. Více informací o práci s kontakty u jednotlivých registrů najdete v kapitole Kontakty domén podle jednotlivých registrů.
Parametry
- tld - doména TLD
- kontakt - pole kontaktních položek:
- cname - jméno kontaktu (prázdné = generuje se automaticky)
- fname - název
- lname - příjmení
- společnost - společnost
- addr_street - ulice a číslo domu
- addr_city - město
- addr_zip - poštovní směrovací číslo
- addr_state - stát nebo oblast
- addr_country - země (dvoupísmenný kód ISO, malá písmena)
- telefon
- fax
- další položky v závislosti na registru
Návratové hodnoty
- 1000 = kontakt byl úspěšně vytvořen
- 2201 = neplatný tld
- 2216 = neplatné jméno kontaktu
- 2218 = jméno kontaktu je vytvořeno automaticky
- 2219 = nevyplněná položka společnost
- 2220 = název položky není vyplněn
- 2221 = nevyplněné příjmení
- 2222 = e-mail není vyplněn
- 2223 = špatný formát e-mailu
- 2224 = email2 není vyplněn
- 2225 = email2 chybný formát
- 2226 = telefon není vyplněn
- 2227 = špatný formát telefonu
- 2228 = fax není vyplněn
- 2229 = chybný formát faxu
- 2230 = nevyplněné ID společnosti
- 2231 = chybný formát ID společnosti
- 2232 = nevyplněné DIČ
- 2233 = chybný formát čísla DPH
- 2234 = ulice není vyplněna
- 2235 = město není vyplněno
- 2236 = ZIP není vyplněn
- 2237 = nevyplněná země
- 2238 = špatný formát země
- 2239 = stav není vyplněn
- 2240 = ostatní nevyplněné údaje
- 2241 = jiná data chybný formát
- 3228 = doména nefunguje s kontakty
- 3230 = nepodařilo se vytvořit kontakt
- 3231 = jméno kontaktu je již použito
- 3232 = kontakt nelze použít - důvod neznámý
- 3233 = kontakt nelze použít
- 3234 = kontakt nelze použít - v karanténě
- 3235 = kontakt nelze použít - vyhrazeno
- 3236 = kontakt nelze použít - blokováno
- 3237 = kontakt je u nás již registrován
- 4211 = nepodařilo se zkontrolovat kontakt - chyba komunikace
- 4213 = nepodařilo se vytvořit kontakt - chyba komunikace
Údaje o odezvě
Kontakt vrátí následující údaje:
- cname - jméno vytvořeného kontaktu
Šablony
Požadavek 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"
}
}
}
}
Odpověď JSON (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "contact-create", "data": { "cname": "contact id" } } }
kontakt-update
K úpravě záznamů kontaktů použijte požadavek na aktualizaci kontaktu.
Vždy se ujistěte, že jste zadali všechny parametry kontaktu, nejen ty, které chcete aktualizovat.
Další informace o práci s kontakty jednotlivých registrů najdete v kapitole Kontakty domén podle jednotlivých registrů.
Autorizujte všechny změny zadáním AUTH-ID(auth_info), pokud nemáte autorizaci nastavenou přímo pro svůj klientský účet (k tomu dojde po prvním úspěšném použití AUTH-ID nebo při vytvoření kontaktu prostřednictvím našeho systému).
Parametry
- tld - TLD
- cname - jméno kontaktu
- auth_info - AUTH-ID
- kontakt - kontaktní položky
- fname - název
- lname - příjmení
- společnost
- addr_street - ulice a číslo popisné
- addr_city - město
- addr_zip - poštovní směrovací číslo
- addr_state - stát nebo oblast
- addr_country - země (dvoupísmenný kód ISO, malá písmena)
- telefon
- fax
- další položky podle rejstříku
Návratové hodnoty
- 1000 = OK
- 2201 = neplatná TLD
- 2207 = neplatná syntaxe v názvu kontaktu
- 2216 = neplatné jméno kontaktu
- 2219 = nevyplněná položka společnost
- 2220 = nevyplněný název položky
- 2221 = nevyplněná položka příjmení
- 2222 = nevyplněná položka e-mailu
- 2223 = špatný formát položky e-mailu
- 2224 = nevyplněná položka email2
- 2225 = chybný formát položky email2
- 2226 = nevyplněná položka telefonu
- 2227 = špatný formát položky telefonu
- 2228 = nevyplněná položka faxu
- 2229 = chybný formát položky faxu
- 2230 = nevyplněná položka ID společnosti
- 2231 = chybný formát položky ID společnosti
- 2232 = nevyplněná položka DIČ
- 2233 = špatný formát položky číslo DPH
- 2234 = nevyplněná položka ulice
- 2235 = nevyplněná položka město
- 2236 = nevyplněná položka zip
- 2237 = nevyplněná položka země
- 2238 = země s nesprávným formátem položky
- 2239 = nevyplněný stav položky
- 2240 = nevyplněná položka ostatní údaje
- 2241 = chybný formát položky v ostatních datech
- 3211 = chyba - nepodařilo se načíst kontakt
- 3238 = chyba autorizace
- 3239 = operace se nezdařila
- 4202 = nedostupný kontakt - chyba spojení, zkuste to později
- 4215 = implementace se nezdařila - chyba připojení, zkuste to později
Údaje o odezvě
Požadavek nevrací žádná data.
Šablony
JSON příkaz:
{
"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"
}
}
}
}
Odpověď JSON (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "contact-update", } }
přenos kontaktů
Pomocí požadavku na přenos kontaktu můžete přenést kontakt z jiného registrátora do systému WEDOS.
Přenos podporují pouze kontakty domén CZ.
Parametry
- tld - TLD
- cname - jméno kontaktu
- auth_info - AUTH-ID
Návratové hodnoty
- 1000 = OK
- 2201 = neplatná TLD
- 2215 = chybí parametr auth_info
- 2216 = neplatný identifikátor kontaktu
- 2244 = Tato doména nepodporuje přenos kontaktů
- 3229 = kontakt není k dispozici
- 3237 = kontakt je u nás již registrován
- 3240 = chyba autorizace
- 3241 = nepodařilo se přenést
- 4216 = neúspěšný - chyba spojení
Údaje o odezvě
Požadavek nevrací žádná data.
Šablony
Požadavek 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"
}
}
}
Odpověď JSON (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "contact-transfer", } }
contact-send-auth-info
Pomocí požadavku contact-send-auth-info odešlete e-mail s AUTH-ID kontaktu.
Parametry
- tld - TLD
- cname - jméno kontaktu
Návratové hodnoty
- 1000 = OK
- 2201 = neplatná TLD
- 2216 = neplatné jméno kontaktu
- 2243 = není povoleno odesílat auth_info
- 3213 = kontakt je nedostupný
- 3215 = nepodařilo se odeslat auth-id
- 3228 = kontakt není pro tuto doménu podporován
- 4217 = odeslání se nezdařilo - chyba komunikace
Údaje o odezvě
Požadavek nevrací žádná data.
Šablony
Požadavek JSON:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "contact-send-auth-info",
"clTRID": "your ID",
"data": {
"tld": "tld",
"cname": "contact id",
}
}
}
Odpověď JSON (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "contact-send-auth-info", } }