WAPI - Domény - Dokumentace a databáze znalostí systému WEDOS

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 článek obsahuje informace o následujících žádostech:

domains-list - seznam domén v účtu zákazníka
domain-check - zkontroluje, zda je doména k dispozici
domain-create - registrace nové domény
domain-info - získání informací o doméně
domain-renew - obnovení domény
domain-update-ns - změna serverů DNS domény
domain-transfer-check - zkontrolujte dostupnost transferu
domain-transfer - převod domény od jiného registrátora
domain-send-auth-info - odeslání AUTH-ID domény
domain-update-keyset - upraví sadu klíčů domény
domain-tld-period-check - kontrola dostupnosti období

seznam domén

Požadavek na seznam domén vrátí seznam všech domén na účtu zákazníka a jejich stav. Vrací také názvy smazaných domén. Pokud má doména přiřazeno více než jedno pořadí, požadavek ji vrátí vícekrát s příslušným stavem (například smazána).

Parametry

status - filtrování podle stavu (nepovinné)

Mezi běžné stavy domény patří:

fee_waiting - čeká na platbu
setup_processing - probíhá vytváření
aktivní
renew_processing - probíhající obnovení
prošlé
zakázané
zrušeno
transfer_fee_waiting - čeká na platbu převodu
transfer_processing - probíhá převod od jiného registrátora
smazáno

Návratové hodnoty

1000 - OK

Údaje o odezvě

Příkaz domains-list vrátí seznam domén, ve kterém každá doména obsahuje následující položky:

name - název domény
status - stav domény

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "domains-list",
    "clTRID": "your ID",
  }
}

Odpověď 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

Pomocí požadavku na kontrolu domény ověřte, zda můžeme doménu zaregistrovat.

Requset kontroly domény podléhá limitu 100 dotazů na doménu za hodinu.

Některé domény nemůžeme zaregistrovat, i když v současné době neexistují. Jména mohou být rezervována, blokována nebo může být jejich registrace omezena jiným způsobem. Vždy záleží na konkrétním registru, jeho pravidlech nebo probíhajících sporech.

Parametry

název – název domény bez www nebo více domén oddělených čárkami

Návratové hodnoty

1000 – doména je k dispozici pro registraci nebo byla vrácena žádost (odpovědní kód pro žádost s více doménami)
3201 - název domény je již použit
3204 - doména je v karanténě
3205 - doména je rezervována
3206 - název domény je blokován

Údaje o odezvě

name - název domény
kód – návratová hodnota pro danou doménu, je zahrnuta v datech pouze v případě, že požadavek kontroluje více domén
výsledek – textová hodnota kódu odpovědi, je zahrnuta v datech pouze v případě, že požadavek kontroluje více domén

Šablony

Požadavek 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"
    }
  }
}

JSON odpověď pro jednu doménu (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "domain-check",
    "data": {
      "name": "your domain without www"
    }
  }
}

JSON odpověď pro více domén (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

K registraci nové domény použijte požadavek na vytvoření domény. Požadavek je buď synchronní, nebo asynchronní, v závislosti na doméně TLD.

Na requset pro vytvoření domény se vztahuje limit 100 dotazů na doménu za hodinu.

U všech domén vyžadujeme my i registr souhlas vlastníka domény s pravidly registrace doménového jména. Naše podmínky vyžadují, abyste své zákazníky seznámili s našimi podmínkami a podmínkami registrátora domén! Pokud tak neučiníte, může to mít v případě sporu za následek odebrání domény bez náhrady.

Parametry

name - název domény včetně TLD - povinné
období - počet let - požadované
dns nebo nsset - seznam serverů DNS nebo NSSET (pouze CZ domény) - povinné.
owner_c - ID kontaktu na vlastníka - povinné
admin_c - ID kontaktu administrátora - nepovinné
pravidla - jméno a příjmení osoby, která souhlasila s našimi podmínkami a podmínkami registru (obvykle vlastník domény).

Možné hodnoty parametru dns:

Prázdná hodnota parametru dns - použít výchozí hodnotu (servery DNS systému WEDOS). Pozor, i když necháte parametr DNS prázdný, musíte jej zadat! Parametr NSSET musí vždy obsahovat hodnotu (např. WEDOS).
Vlastní konfigurace DNS - nelze použít pro CZ domény (každý záznam musí obsahovat pole name, volitelně addr_ip4 a addr_ip6, jednotlivé servery jsou vnořeny do prvku server). Podrobnosti viz šablona.

Návratové hodnoty

1000 - doména byla úspěšně zaregistrována
1001 - asynchronní žádost o registraci přijata
3002 - nedostatečný kredit na úvěrovém účtu
3201 - název domény je již použit
3204 - doména je v karanténě
3205 - doména je rezervována
3206 - název domény je blokován
2201 - nepodporovaná TLD
2203 - neplatné období
3221 - vytvoření se nezdařilo
4207 - vytvoření se nezdařilo - chyba připojení

Údaje o odezvě

Po úspěšné registraci domény jsou v datovém uzlu vráceny následující položky:

num - číslo objednávky
expirace - datum expirace domény
úvěr - stav kreditního účtu po dokončení operace
- částka - kreditní zůstatek účtu
- měna - měna

Šablony

Požadavek JSON s 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"
      }
    }
  }
}

Požadavek JSON s vlastním 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"
      }
    }
  }
}

Odpověď 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

Požadavek domain-info slouží k získání informací o konkrétní doméně.

Příkaz funguje pouze pro domény v příslušném zákaznickém účtu.

Parametry

name - název domény, pro více domén použijte řetězec oddělený čárkou (viz šablona) - povinné

Návratové hodnoty

1000 - příkaz byl úspěšný, element data obsahuje informace o doméně
3222 - nepodařilo se načíst objekt domény
3216 - nepodařilo se načíst informace o doméně
3223 - doména nepatří k vašemu zákaznickému účtu
4205 - chyba v souvislosti s registrem

Návratová hodnota pro více domén je vždy 1000. Případné chybové hodnoty se zobrazí v údajích domény, jak je uvedeno v šabloně.

Údaje o odezvě

Datový prvek obsahuje informace o doméně v případě úspěchu. Konkrétní údaje závisí na typu domény a dalších okolnostech. Zde jsou uvedeny ty nejdůležitější:

name - název domény
status - stav domény
owner_c - ID vlastníka domény
setup_date - datum vytvoření
expirace - datum vypršení platnosti
dns nebo NSSET - Seznam serverů DNS nebo NSSET
položky s prefixem own_ - informace o vlastníkovi domény

Některé informace o doméně nebo jejím vlastníkovi mohou být skryté; v takovém případě mají hodnotu HIDDEN.

Šablony

Požadavek JSON se 2 doménami:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "domain-info",
    "clTRID": "your ID",
    "data": {
      "name": "domain.name1, domain.name2"
    }
  }
}

Odpověď JSON (domain.name1 OK, domain.name2 error):

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

Požadavek na obnovení domény umožňuje prodloužit doménu, která ještě nemá objednané prodloužení.

Ve výchozím nastavení se systém automaticky pokouší obnovit domény 30 dní před vypršením platnosti. Toto chování můžete zakázat v nastavení účtu ⧉.

Parametry

name - název domény - povinné
období - počet let k obnovení - požadováno

Návratové hodnoty

1000 - Doména byla úspěšně obnovena
2203 - Neplatné období obnovení
2269 - žádost o prodloužení již existuje

Údaje o odezvě

Pokud je příkaz úspěšný, vrátí nové datum vypršení platnosti.

expirace - datum expirace nové domény

Šablony

Požadavek 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"
    }
  }
}

Odpověď 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

Ke změně serverů DNS domény nebo NSSET použijte požadavek domain-update-ns.

Parametry

name - název domény - povinné
dns nebo nsset - DNS servery nebo NSSET pro CZ domény - povinné

Možné hodnoty parametru dns:

Prázdná hodnota parametru dns - použít výchozí hodnotu (servery DNS systému WEDOS). Pozor, i když necháte parametr DNS prázdný, musíte jej zadat! Parametr NSSET musí vždy obsahovat hodnotu (např. WEDOS).
Vlastní konfigurace DNS - nelze použít pro CZ domény (každý záznam musí obsahovat pole name, volitelně addr_ip4 a addr_ip6, jednotlivé servery jsou vnořeny do prvku server). Podrobnosti viz šablona.

Návratové hodnoty

1000 - servery DNS úspěšně nastaveny
2209 - neplatný formát NSSET (pro domény CZ)
2210 - neplatný formát serveru DNS

Údaje o odezvě

Požadavek nevrací žádná data.

Šablony

Požadavek 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"
          }
        }
      }
    }
  }  
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "domain-update-ns",
  }
}

domain-transfer-check

Pomocí požadavku domain-transfer-check můžete zkontrolovat, zda lze doménu převést od jiného registrátora k nám.

Na stránkách domain-transfer-check requset podléhá limitu 100 dotazů na doménu za hodinu.

Parametry

name - název domény bez www - povinné

Návratové hodnoty

Požadavek obvykle vrací následující hodnoty:

1000 - Přenos je možný
3217 - Nepodařilo se navázat spojení s registrem
3218 - Přenos není možný

Údaje o odezvě

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "domain-transfer-check",
    "clTRID": "your ID",
    "data": {
      "name": "domain.tld"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "domain-transfer-check"
  }
}

přenos domény

K převodu domény od jiného registrátora do společnosti WEDOS použijte žádost o převod domény.

Požadavek je synchronní pouze pro domény CZ a EU, tj. v případě, že je AUTH-ID správné, je přenos proveden okamžitě a výsledek se dozvíte ihned. Pro ostatní domény jsou převody asynchronní, takže se výsledek dozvíte prostřednictvím notifikace.

Na stránkách přenos domény requset podléhá limitu 100 dotazů na doménu za hodinu.

Parametry

name - název domény bez www - povinné
auth_info - doména AUTH-ID - povinné
owner_c - ID vlastníka domény - povinné pouze pro některé registry (SK, EU, gTLD)
dns - konfigurace doménového serveru DNS - nepovinné; dostupné pouze pro registry, které to podporují (EU, gTLD).
pravidla - jméno a příjmení osoby, která souhlasila s našimi podmínkami a podmínkami registru (typicky vlastník domény) - vyžadováno

Dostupné hodnoty parametru dns:

Parametr DNS vynechán - doména si zachová aktuální nastavení serveru DNS. Během přenosu budou aktuální servery DNS přeloženy. Pokud není možné aktuální servery DNS přeložit, může přenos skončit chybou (gTLD).
Prázdný parametr DNS - systém se pokusí nastavit výchozí servery DNS systému WEDOS.
Parametr DNS se servery - systém se pokusí tyto servery DNS nastavit.

Návratové hodnoty

1000 - Doména byla úspěšně převedena
1001 - Žádost o převod byla přijata, čeká se na realizaci
2100 - Chybí požadovaný parametr
2101 - Neplatná hodnota parametru
2201 - Neplatná TLD
2202 - Nesprávný formát názvu domény
2204 - Identifikátor kontaktu vlastníka domény není zadán
2207 - Neplatný identifikátor kontaktu vlastníka domény
2210 - Nesprávný formát serveru DNS
2215 - AUTH-ID nebylo zadáno a je pro tuto doménu vyžadováno.
2245 - Chybí souhlas
2246 - Chyba v údajích o souhlasu
2252 - Překročení požadavků na doménu
2263 - AUTH-ID je kratší než požadovaná minimální délka
2271 - Nesprávný formát AUTH-ID
3001 - Neplatná měna kreditního účtu
3003 - Neplatné fakturační údaje kreditního účtu
3207 - Doména je u nás již registrována
3208 - Přenos se nezdařil kvůli problému s datem vypršení platnosti
3217 - Nepodařilo se navázat spojení s registrem
3218 - Přenos není možný
3219 - Již čekající žádost o převod této domény
3220 - Doména je již zaregistrována v našem registru
3226 - Nepodařilo se přenést doménu
3227 - Chyba autorizace v registru domén
3258 - Prostoje registru
3266 - Nelze převést, protože platnost domény vypršela
3267 - Autoritativní servery DNS se nepodařilo přeložit
4002 - Nepodařilo se odečíst kredit z kreditního účtu
4003 - Nepodařilo se vytvořit zúčtovací období
4206 - Nepodařilo se zjistit, zda lze doménu přenést - chyba připojení
4209 - Nepodařilo se určit typ převodu (s/bez prodloužení)
5001 - Interní chyba přihlášení
5002 - Nepodařilo se vypočítat převodní cenu
5004 - Prostoje ve fakturaci

Údaje o odezvě

num - číslo objednávky
expirace - datum expirace domény

Šablony

Požadavek 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"
      }
   }
}

Odpověď 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

Požadavek domain-send-auth-info slouží k odeslání AUTH-ID domény na e-mail vlastníka domény.

Parametry

name - název domény - povinné

Návratové hodnoty

1000 - AUTH-ID je odesláno na e-mail vlastníka domény
2243 - Není povoleno odesílat auth_info
3209 - Nepodařilo se odeslat auth_info
3210 - Nepodařilo se odeslat auth_info - doména je nedostupná
3222 - Nepodařilo se načíst doménu
3223 - Doména nepatří k tomuto účtu zákazníka
4214 - Nepodařilo se odeslat auth_info - chyba připojení - zkuste to později

Údaje o odezvě

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "domain-send-auth-info",
    "clTRID": "your ID",
    "data": {
      "name": "domain.tld"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "domain-send-auth-info"
  }
}

domain-update-keyset

Požadavek domain-update-keyset umožňuje provést změny nastavení KEYSET pro doménu, tj. povolit, zakázat nebo aktualizovat nastavení DNSSEC.

Parametry

name - název domény - povinné
keyset - nastavení KEYSET - povinné
0 = žádný KEYSET / vypnout DNSSEC
1 = náš KEYSET / náš DNSSEC (pokud doména používá naše DNS servery a je nastavena jako primární)
string = název vašeho vlastního KEYSET (pokud doména nepoužívá naše DNS servery nebo je nastavena jako sekundární)

Návratové hodnoty

1000 = OK
2202 = neplatný nebo nepodporovaný název existující domény
2264 = neplatný název KEYSET
2265 = bez podpory DNSSEC
2266 = nepodporovaná akce pro sekundární doménu
2267 = nepodporovaná akce pro primární doménu
3260 = příkaz DNSSEC již existuje
3258 = probíhající odstávka registru
3263 = doména nepoužívá náš DNS
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3259 = KEYSET není k dispozici
3262 = nastavení DNSSEC se nezdařilo
3264 = KEYSET je blokován

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "domain-update-keyset",
    "clTRID": "your ID",
    "data": {
      "name": "domain name",
      "keyset": "0/1/string",
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "domain-update-keyset"
  }
}

domain-tld-period-check

Pomocí požadavku domain-tld-period-check zjistíte, zda lze pro TLD nastavit určité registrační období.

Parametry

tld - TLD
období - počet let

Návratové hodnoty

1000 - pro tuto doménu lze použít období
2203 -období nelze pro tuto doménu použít

Údaje o odezvě

Požadavek nevrací žádná data.

Šablony

JSON příkaz:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "domain-tld-period-check",
    "clTRID": "your ID",
    "data": {
      "tld": "domain tld",
      "period": "number of years"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "domain-tld-period-check"
  }
}

Bylo to užitečné?

Děkujeme za váš názor!

WAPI - Domény

seznam domén

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-check

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-create

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-info

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-renew

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-update-ns

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-transfer-check

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

přenos domény

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-send-auth-info

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

domain-update-keyset

Parametry

Návratové hodnoty

Vrátit data

Šablony

domain-tld-period-check

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

Bylo to užitečné?

Článek TOC

Procházet kategorie