WAPI – Domény

Na této stráncedomains-listdomain-checkdomain-createdomain-infodomain-renewdomain-update-nsdomain-transfer-checkdomain-transferdomain-send-auth-infodomain-update-keysetdomain-tld-period-check

Tento článek se věnuje příkazům WAPI konkrétně pro službu WEDOS DNS. Informace o nastavení WAPI a řešení běžných problémů najdete v článku WAPI – Manuál.

Tento článek přináší informace o těchto požadavcích:


domains-list

Tlačítko domains-list požadavek vrátí seznam všech domén v zákaznickém účtu a jejich stav. Vrací také názvy smazaných domén. Pokud má doména přiřazeno více objednávek, požadavek ji vrátí vícekrát s odpovídajícím stavem (například smazaná).

Parametry

  • status – filtrovat podle stavu (volitelné)

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

  • fee_waiting – čeká na platbu
  • setup_processing – probíhá vytváření
  • active
  • renew_processing – probíhá prodloužení
  • expirováno
  • disabled
  • zrušeno
  • transfer_fee_waiting – čeká na platbu za převod
  • transfer_processing – probíhá převod od jiného registrátora
  • smazáno

Návratové hodnoty

  • 1000 – OK

Data odpovědi

Příkaz domains-list vrací seznam domén, přičemž každá doména obsahuje tyto položky:

  • name – název domény
  • status – stav domény

Šablony

JSON požadavek:

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

JSON odpověď (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

Použijte domain-check požadavek pro ověření, zda můžeme doménu zaregistrovat.

Tlačítko domain-check požadavek podléhá limitu 100 dotazů na domény za hodinu.

Některé domény nemůžeme zaregistrovat, i když aktuálně neexistují. Jména mohou být rezervovaná, blokovaná nebo jejich registrace může být jinak omezená. Vždy záleží na konkrétním registru, jeho pravidlech nebo probíhajících sporech.

Parametry

  • name – název domény bez www, nebo více domén oddělených čárkou

Návratové hodnoty

  • 1000 – doména je volná k registraci, nebo požadavek vrácen (kód odpovědi pro požadavek 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 rezervovaná
  • 3206 – název domény je blokován

Data odpovědi

  • name – název domény
  • kód – návratová hodnota pro danou doménu, je zahrnuta v data pouze tehdy, pokud požadavek kontroluje více domén
  • result – textová hodnota kódu odpovědi, je zahrnuta v data pouze tehdy, pokud požadavek kontroluje více domén

Šablony

JSON požadavek:

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

Použijte domain-create požadavek pro registraci nové domény. Požadavek je synchronní, nebo asynchronní podle TLD domény.

Tlačítko domain-create požadavek podléhá limitu 100 dotazů na domény za hodinu.

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

Parametry

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

Možné dns hodnoty parametru:

  • Prázdná hodnota parametru dns – použije se výchozí hodnota (DNS servery WEDOS). Pozor, i když necháte parametr DNS prázdný, musíte jej uvést! 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 name pole, volitelně addr_ip4 a addr_ip6, jednotlivé servery jsou vnořeny v elementu server). Podrobnosti najdete v šabloně.

Návratové hodnoty

  • 1000 – doména byla úspěšně zaregistrována
  • 1001 – asynchronní požadavek na registraci byl přijat
  • 3002 – nedostatek kreditu na zálohovém účtu
  • 3201 – název domény je již použit
  • 3204 – doména je v karanténě
  • 3205 – doména je rezervovaná
  • 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 spojení

Data odpovědi

Po úspěšné registraci domény se v uzlu data vrací následující položky:

  • num – číslo objednávky
  • expirace – datum expirace domény
  • kredit – stav zálohového účtu po dokončení operace
    • amount – zůstatek zálohového účtu
    • currency – měna

Šablony

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

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

JSON odpověď (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

Použijte domain-info požadavek pro získání informací o konkrétní doméně.

Příkaz funguje pouze na doménách v odpovídajícím zákaznickém účtu.

Parametry

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

Návratové hodnoty

  • 1000 – příkaz proběhl úspěšně, prvek 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 spojení s registrem

Návratová hodnota pro více domén je vždy 1000. Případné chybové hodnoty se zobrazují v doména datech, jak je uvedeno v šabloně.

Data odpovědi

Prvek data obsahuje při úspěchu informace o doméně. Konkrétní data závisejí na typu domény a dalších okolnostech. Zde jsou 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 expirace
  • dns nebo NSSET – seznam DNS serverů nebo NSSET
  • položky s own_ předpona – informace o vlastníkovi domény

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

Šablony

JSON požadavek se 2 doménami:

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

JSON odpověď (domain.name1 OK, domain.name2 chyba):

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

Tlačítko domain-renew požadavek umožňuje prodloužit doménu, která zatím nemá objednané prodloužení.

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

Parametry

  • name – název domény – povinné
  • období – počet let prodloužení – povinné

Návratové hodnoty

  • 1000 – doména byla úspěšně prodloužena
  • 2203 – neplatné období prodloužení
  • 2269 – požadavek na prodloužení již existuje

Data odpovědi

Při úspěchu vrátí tento příkaz nové datum expirace.

  • expirace – nové datum expirace domény

Šablony

JSON požadavek:

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

JSON odpověď (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

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

Parametry

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

Možné dns hodnoty parametru:

  • Prázdná hodnota parametru dns – použije se výchozí hodnota (DNS servery WEDOS). Pozor, i když necháte parametr DNS prázdný, musíte jej uvést! 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 name pole, volitelně addr_ip4 a addr_ip6, jednotlivé servery jsou vnořeny v elementu server). Podrobnosti najdete v šabloně.

Návratové hodnoty

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

Data odpovědi

Požadavek nevrací žádná data.

Šablony

JSON požadavek:

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

JSON odpověď (OK):

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

domain-transfer-check

Použijte domain-transfer-check požadavek pro ověření, zda lze doménu převést od jiného registrátora k nám.

Tlačítko domain-transfer-check požadavek podléhá limitu 100 dotazů na domény za hodinu.

Parametry

  • name – název domény bez www – povinné

Návratové hodnoty

Požadavek obvykle vrací tyto hodnoty:

  • 1000 – převod je možný
  • 3217 – nepodařilo se navázat spojení s registrem
  • 3218 – převod není možný

Data odpovědi

Požadavek nevrací žádná data.

Šablony

JSON požadavek:

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

domain-transfer

Použijte domain-transfer požadavek pro převod domény od jiného registrátora k WEDOS.

Požadavek je synchronní pouze u domén CZ a EU, tj. u nich se při správném AUTH-ID převod provede okamžitě a výsledek znáte hned. U ostatních domén jsou převody asynchronní, takže se výsledek dozvíte prostřednictvím notifikace.

Tlačítko domain-transfer požadavek podléhá limitu 100 dotazů na domény za hodinu.

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

Parametry

  • name – název domény bez www – povinné
  • auth_info – AUTH-ID domény – povinné
  • owner_c – ID vlastníka domény – povinné jen u některých registrů (SK, EU, gTLD)
  • dns – konfigurace DNS serverů domény – volitelné; dostupné pouze u registrů, které to podporují (EU, gTLD)
  • pravidla – jméno a příjmení osoby, která souhlasila s našimi obchodními podmínkami a s podmínkami registru (obvykle vlastník domény) – povinné

Dostupné hodnoty ​​parametru dns parametr:

  • Parametr DNS vynechán – doména si zachová aktuální nastavení DNS serverů. Při převodu budou aktuální DNS servery zjištěny. Pokud není možné aktuální DNS servery zjistit, může převod skončit chybou (gTLD).
  • Prázdný parametr DNS – systém se pokusí nastavit výchozí DNS servery WEDOS.
  • Parametr DNS se servery – systém se pokusí nastavit tyto DNS servery.

Návratové hodnoty

  • 1000 – doména byla úspěšně převedena
  • 1001 – požadavek na převod byl přijat, čeká na provedení
  • 2100 – chybí povinný parametr
  • 2101 – neplatná hodnota parametru
  • 2201 – neplatné TLD
  • 2202 – neplatný formát názvu domény
  • 2204 – nebyl zadán identifikátor kontaktu vlastníka domény
  • 2207 – neplatný identifikátor kontaktu vlastníka domény
  • 2210 – neplatný formát DNS serveru
  • 2215 – AUTH-ID nebylo zadáno a je pro tuto doménu povinné
  • 2245 – chybí souhlas
  • 2246 – chyba dat souhlasu
  • 2252 – překročen počet dotazů na domény
  • 2263 – AUTH-ID je kratší než požadovaná minimální délka
  • 2271 – neplatný formát AUTH-ID
  • 3001 – neplatná měna zálohového účtu
  • 3003 – neplatné fakturační údaje zálohového účtu
  • 3207 – doména je již registrovaná u nás
  • 3208 – převod se nezdařil kvůli problému s datem expirace
  • 3217 – nepodařilo se navázat spojení s registrem
  • 3218 – převod není možný
  • 3219 – pro tuto doménu již probíhá požadavek na převod
  • 3220 – doména je již registrovaná v našem registru
  • 3226 – nepodařilo se převést doménu
  • 3227 – chyba autorizace u registru domén
  • 3258 – odstávka registru
  • 3266 – nelze převést, protože doména vypršela
  • 3267 – autoritativní DNS servery se nepodařilo přeložit
  • 4002 – nepodařilo se odečíst kredit ze zálohového účtu
  • 4003 – nepodařilo se vytvořit fakturační období
  • 4206 – nepodařilo se zjistit, zda lze doménu převést – chyba spojení
  • 4209 – nepodařilo se určit typ převodu (s prodloužením / bez prodloužení)
  • 5001 – interní chyba přihlášení
  • 5002 – nepodařilo se vypočítat cenu převodu
  • 5004 – odstávka fakturace

Data odpovědi

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

Šablony

JSON požadavek:

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

JSON odpověď (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

Použijte domain-send-auth-info požadavek pro 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 bylo odesláno na e-mail vlastníka domény 
  • 2243 – odeslání auth_info není povoleno
  • 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 zákaznickému účtu
  • 4214 – nepodařilo se odeslat auth_info – chyba spojení – zkuste to později

Data odpovědi

Požadavek nevrací žádná data.

Šablony

JSON požadavek:

{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-send-auth-info",
"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-send-auth-info"
  }
}

domain-update-keyset

Tlačítko domain-update-keyset požadavek umožňuje provést změny nastavení KEYSET domény, tedy zapnout, vypnout nebo aktualizovat nastavení DNSSEC.

Parametry

  • name – název domény – povinné
  • keyset – nastavení KEYSET – povinné
    0 = bez KEYSET / vypnout DNSSEC
    1 = náš KEYSET / náš DNSSEC (pokud doména používá naše DNS servery a je nastavena jako primary)
    řetězec = název vašeho vlastního KEYSETu (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 secondary doménu
  • 2267 = nepodporovaná akce pro primary doménu
  • 3260 = již existuje čekající objednávka DNSSEC
  • 3258 = probíhá odstávka registru
  • 3263 = doména nepoužívá naše DNS
  • 3222 = otevření domény selhalo
  • 3223 = přístup odepřen
  • 3259 = KEYSET není dostupný
  • 3262 = Nastavení DNSSEC selhalo
  • 3264 = KEYSET je blokovaný

Návratová data

Požadavek nevrací žádná data.

Šablony

JSON požadavek:

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

JSON odpověď (OK):

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

domain-tld-period-check

Použijte domain-tld-period-check požadavek pro zjištění, zda lze pro dané TLD nastavit určité registrační období.

Parametry

  • tld – TLD
  • období – počet let

Návratové hodnoty

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

Data odpovědi

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

JSON odpověď (OK):

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

Pomohl vám tento návod?

Vaše hodnocení nám pomáhá návody zlepšovat.

Vzkaz si přečte redakce návodů, ale neodpovídá na něj. Když potřebujete poradit, zeptejte se na komunitním webu Help. Nepište sem hesla ani osobní údaje.

Nenašli jste, co hledáte?

Pošlete nám dotaz přes kontaktní formulář.