WAPI - Domény - Dokumentácia a znalostná báza WEDOS

Tento článok sa venuje príkazom WAPI konkrétne pre službu WEDOS DNS. Informácie o nastavení WAPI a riešení bežných problémov nájdete v článku WAPI – Manuál.

Tento článok poskytuje informácie o nasledujúcich požiadavkách:

domains-list – výpis domén v zákazníckom účte
domain-check – kontrola dostupnosti domény
domain-create – registrácia novej domény
domain-info – získanie informácií o doméne
domain-renew – predĺženie domény
domain-update-ns – zmena DNS serverov domény
domain-transfer-check – kontrola možnosti transferu
domain-transfer – prevod domény od iného registrátora
domain-send-auth-info – odoslanie AUTH-ID domény
domain-update-keyset – úprava keysetu domény
domain-tld-period-check – kontrola dostupnosti obdobia

domains-list

Tento domains-list požiadavka vracia zoznam všetkých domén v zákazníckom účte a ich stav. Vracia aj názvy zmazaných domén. Ak má doména priradenú viac ako jednu objednávku, požiadavka ju vráti viackrát so zodpovedajúcim stavom (napríklad zmazané).

Parametre

status – filtrovanie podľa stavu (voliteľné)

Medzi bežné stavy domén patria:

fee_waiting – čaká na platbu
setup_processing – prebieha vytváranie
aktívna
renew_processing – prebieha predĺženie
expirované
vypnuté
zrušené
transfer_fee_waiting – čaká na platbu za transfer
transfer_processing – prebieha transfer od iného registrátora
zmazané

Návratové hodnoty

1000 – OK

Dáta odpovede

Príkaz domains-list vracia zoznam domén, v ktorom každá doména obsahuje nasledujúce položky:

name – názov domény
status – stav domény

Šablóny

JSON požiadavka:

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

JSON odpoveď (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žite domain-check požiadavka na overenie, či môžeme doménu zaregistrovať.

Tento domain-check požiadavka podlieha limitu 100 dopytov na domény za hodinu.

Niektoré domény nemôžeme zaregistrovať, hoci momentálne neexistujú. Názvy môžu byť rezervované, blokované alebo môže byť ich registrácia obmedzená iným spôsobom. Vždy to závisí od konkrétneho registra, jeho pravidiel alebo prebiehajúcich sporov.

Parametre

name – názov domény bez www, alebo viac domén oddelených čiarkou

Návratové hodnoty

1000 – doména je dostupná na registráciu, alebo požiadavka vrátená (kód odpovede pre požiadavku s viacerými doménami)
3201 – názov domény je už použitý
3204 – doména je v karanténe
3205 – doména je rezervovaná
3206 – názov domény je blokovaný

Dáta odpovede

name – názov domény
kód – návratová hodnota pre danú doménu, je zahrnutá v data iba vtedy, ak požiadavka kontroluje viac domén
výsledok – textová hodnota kódu odpovede, je zahrnutá v data iba vtedy, ak požiadavka kontroluje viac domén

Šablóny

JSON požiadavka:

{
  "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 odpoveď pre 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 odpoveď pre viac 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žite domain-create požiadavka na registráciu novej domény. Požiadavka je synchrónna, alebo asynchrónna, podľa TLD domény.

Tento domain-create požiadavka podlieha limitu 100 dopytov na domény za hodinu.

Pri všetkých doménach my aj register vyžadujeme súhlas vlastníka domény s pravidlami registrácie doménových mien. Naše obchodné podmienky vyžadujú, aby ste svojich zákazníkov oboznámili s našimi obchodnými podmienkami a podmienkami registrátora domén! Ak tak neurobíte, môže byť doména v prípade sporu bez náhrady odobratá.

Parametre

name – názov domény vrátane TLD – povinné
obdobie – počet rokov – povinné
dns alebo nsset – zoznam DNS serverov alebo NSSET (iba CZ domény) – povinné
owner_c – ID kontaktu vlastníka – povinné
admin_c – ID administratívneho kontaktu – voliteľné
pravidlá – meno a priezvisko osoby, ktorá súhlasila s našimi obchodnými podmienkami a podmienkami registra (typicky vlastník domény)

Možné dns hodnoty parametra:

Prázdna hodnota parametra dns – použiť predvolenú hodnotu (DNS servery WEDOS). Pozor, aj keď necháte parameter DNS prázdny, stále ho musíte uviesť! Parameter NSSET musí vždy obsahovať hodnotu (napr. WEDOS).
Vlastná konfigurácia DNS – nemožno použiť pre CZ domény (každý záznam musí obsahovať name pole, prípadne addr_ip4 a addr_ip6, jednotlivé servery sú vnorené v elemente server). Podrobnosti nájdete vo vzore.

Návratové hodnoty

1000 – doména bola úspešne zaregistrovaná
1001 – asynchrónna požiadavka na registráciu prijatá
3002 – nedostatok kreditu na kreditnom účte
3201 – názov domény je už použitý
3204 – doména je v karanténe
3205 – doména je rezervovaná
3206 – názov domény je blokovaný
2201 – nepodporované TLD
2203 – neplatné obdobie
3221 – vytvorenie zlyhalo
4207 – vytvorenie zlyhalo – chyba spojenia

Dáta odpovede

Po úspešnej registrácii domény sa v uzle data vrátia nasledujúce položky:

num – číslo objednávky
expirácia – dátum expirácie domény
kredit – stav kreditného účtu po dokončení operácie
- suma – zostatok kreditného účtu
- mena – mena

Šablóny

JSON požiadavka 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žiadavka 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 odpoveď (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žite domain-info požiadavka na získanie informácií o konkrétnej doméne.

Príkaz funguje iba pre domény v zodpovedajúcom zákazníckom účte.

Parametre

name – názov domény, pre viac domén použite reťazec oddelený čiarkami (pozri šablónu) – povinné

Návratové hodnoty

1000 – príkaz bol úspešný, prvok data obsahuje informácie o doméne
3222 – nepodarilo sa načítať objekt domény
3216– nepodarilo sa načítať informácie o doméne
3223 – doména nepatrí k vášmu zákazníckemu účtu
4205 – chyba spojenia s registrom

Návratová hodnota pre viac domén je vždy 1000. Prípadné chybové hodnoty sa zobrazujú vdoménadáta, ako je uvedené v šablóne.

Dáta odpovede

Prvok data obsahuje pri úspechu informácie o doméne. Konkrétne dáta závisia od typu domény a ďalších okolností. Tu sú tie najdôležitejšie:

name – názov domény
status – stav domény
owner_c – ID vlastníka domény
setup_date – dátum vytvorenia
expirácia – dátum expirácie
dns alebo NSSET – zoznam DNS serverov alebo NSSET
položky s own_ prefix – informácie o vlastníkovi domény

Niektoré informácie o doméne alebo jej vlastníkovi môžu byť skryté; v takom prípade majú hodnotu HIDDEN.

Šablóny

JSON požiadavka s 2 doménami:

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

JSON odpoveď (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

Tento domain-renew požiadavka umožňuje predĺžiť doménu, ktorá zatiaľ nemá objednané predĺženie.

Systém sa predvolene pokúša obnoviť domény 30 dní pred vypršaním platnosti. Toto správanie môžete vypnúť vo svojej nastavenia účtu &boxbox;.

Parametre

name – názov domény – povinné
obdobie – počet rokov predĺženia – povinné

Návratové hodnoty

1000 – doména bola úspešne predĺžená
2203 – neplatné obdobie predĺženia
2269 – požiadavka na predĺženie už existuje

Dáta odpovede

Pri úspechu tento príkaz vráti nový dátum vypršania.

expirácia – nový dátum expirácie domény

Šablóny

JSON požiadavka:

{
  "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 odpoveď (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žite domain-update-ns požiadavka na zmenu DNS serverov alebo NSSET domény.

Parametre

name – názov domény – povinné
dns alebo nsset – DNS servery alebo NSSET pre CZ domény – povinné

Možné dns hodnoty parametra:

Prázdna hodnota parametra dns – použiť predvolenú hodnotu (DNS servery WEDOS). Pozor, aj keď necháte parameter DNS prázdny, stále ho musíte uviesť! Parameter NSSET musí vždy obsahovať hodnotu (napr. WEDOS).
Vlastná konfigurácia DNS – nemožno použiť pre CZ domény (každý záznam musí obsahovať name pole, prípadne addr_ip4 a addr_ip6, jednotlivé servery sú vnorené v elemente server). Podrobnosti nájdete vo vzore.

Návratové hodnoty

1000 – DNS servery úspešne nastavené
2209 – neplatný formát NSSET (pre CZ domény)
2210 – neplatný formát DNS servera

Dáta odpovede

Požiadavka nevracia žiadne dáta.

Šablóny

JSON požiadavka:

{
  "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 odpoveď (OK):

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

domain-transfer-check

Použite domain-transfer-check požiadavka na overenie, či možno doménu previesť od iného registrátora k nám.

Tento domain-transfer-check požiadavka podlieha limitu 100 dopytov na domény za hodinu.

Parametre

name – názov domény bez www – povinné

Návratové hodnoty

Požiadavka obvykle vracia nasledujúce hodnoty:

1000 – transfer je možný
3217 – nepodarilo sa nadviazať spojenie s registrom
3218 – transfer nie je možný

Dáta odpovede

Požiadavka nevracia žiadne dáta.

Šablóny

JSON požiadavka:

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

JSON odpoveď (OK):

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

domain-transfer

Použite domain-transfer požiadavka na prevod domény od iného registrátora k WEDOS.

Požiadavka je synchrónna iba pre domény CZ a EU, t. j. pri nich sa pri správnom AUTH-ID prevod vykoná okamžite a výsledok poznáte hneď. Pri ostatných doménach sú prevody asynchrónne, takže výsledok zistíte prostredníctvom notifikácie.

Tento domain-transfer požiadavka podlieha limitu 100 dopytov na domény za hodinu.

Parametre

name – názov domény bez www – povinné
auth_info – AUTH-ID domény – povinné
owner_c – ID vlastníka domény – povinné iba pre niektoré registre (SK, EU, gTLD)
dns – konfigurácia DNS serverov domény – voliteľné; dostupné iba pri registroch, ktoré to podporujú (EU, gTLD)
pravidlá – meno a priezvisko osoby, ktorá súhlasila s našimi obchodnými podmienkami a podmienkami registra (typicky vlastník domény) – povinné

Dostupné hodnoty pre dns parameter:

Vynechaný parameter DNS – doména si ponechá aktuálne nastavenie DNS serverov. Počas transferu budú aktuálne DNS servery zistené. Ak aktuálne DNS servery nemožno zistiť, môže transfer skončiť chybou (gTLD).
Prázdny parameter DNS – systém sa pokúsi nastaviť predvolené DNS servery WEDOS.
Parameter DNS so servermi – systém sa pokúsi nastaviť tieto DNS servery.

Návratové hodnoty

1000 – doména úspešne prevedená
1001 – požiadavka na transfer bola prijatá, čaká na vykonanie
2100 – chýba povinný parameter
2101 – neplatná hodnota parametra
2201 – neplatné TLD
2202 – neplatný formát názvu domény
2204 – nebol zadaný identifikátor kontaktu vlastníka domény
2207 – neplatný identifikátor kontaktu vlastníka domény
2210 – neplatný formát DNS servera
2215 – AUTH-ID nebolo zadané a je pre túto doménu povinné
2245 – chýba súhlas
2246 – chyba dát súhlasu
2252 – prekročený počet dopytov na domény
2263 – AUTH-ID je kratšie než požadovaná minimálna dĺžka
2271 – neplatný formát AUTH-ID
3001 – neplatná mena kreditného účtu
3003 – neplatné fakturačné údaje kreditného účtu
3207 – doména je už registrovaná u nás
3208 – transfer zlyhal kvôli problému s dátumom expirácie
3217 – nepodarilo sa nadviazať spojenie s registrom
3218 – transfer nie je možný
3219 – pre túto doménu už prebieha požiadavka na transfer
3220 – doména je už registrovaná v našom registri
3226 – nepodarilo sa previesť doménu
3227 – chyba autorizácie v registri domén
3258 – výpadok registra
3266 – nemožno previesť, pretože doména je expirovaná
3267 – autoritatívne DNS servery sa nepodarilo preložiť
4002 – nepodarilo sa odpočítať kredit z kreditného účtu
4003 – nepodarilo sa vytvoriť fakturačné obdobie
4206 – nepodarilo sa zistiť, či možno doménu previesť – chyba spojenia
4209 – nepodarilo sa určiť typ transferu (s predĺžením / bez predĺženia)
5001 – interná chyba prihlásenia
5002 – nepodarilo sa vypočítať cenu transferu
5004 – výpadok fakturácie

Dáta odpovede

num – číslo objednávky
expirácia – dátum expirácie domény

Šablóny

JSON požiadavka:

{
  "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 odpoveď (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žite domain-send-auth-info požiadavka na odoslanie AUTH-ID domény na e-mail vlastníka domény.

Parametre

name – názov domény – povinné

Návratové hodnoty

1000 – AUTH-ID je odoslané na e-mail vlastníka domény
2243 – odoslanie auth_info nie je povolené
3209 – nepodarilo sa odoslať auth_info
3210 – nepodarilo sa odoslať auth_info – doména je nedostupná
3222 – nepodarilo sa načítať doménu
3223 – doména nepatrí k tomuto zákazníckemu účtu
4214 – nepodarilo sa odoslať auth_info – chyba spojenia – skúste to neskôr

Dáta odpovede

Požiadavka nevracia žiadne dáta.

Šablóny

JSON požiadavka:

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

JSON odpoveď (OK):

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

domain-update-keyset

Tento domain-update-keyset požiadavka umožňuje vykonávať zmeny v nastavení KEYSET pre doménu, t. j. zapnúť, vypnúť alebo aktualizovať nastavenie DNSSEC.

Parametre

name – názov domény – povinné
keyset – nastavenie KEYSET – povinné
0 = žiadny KEYSET / vypnúť DNSSEC
1 = náš KEYSET / náš DNSSEC (ak doména používa naše DNS servery a je nastavená ako primárna)
reťazec = názov vášho vlastného KEYSET (ak doména nepoužíva naše DNS servery alebo je nastavená ako sekundárna)

Návratové hodnoty

1000 = OK
2202= neplatný, prípadne nepodporovaný názov existujúcej domény
2264 = neplatný názov KEYSET
2265 = bez podpory DNSSEC
2266 = nepodporovaná akcia pre sekundárnu doménu
2267 = nepodporovaná akcia pre primárnu doménu
3260 = už existuje čakajúca objednávka DNSSEC
3258 = prebieha odstávka registra
3263 = doména nepoužíva naše DNS
3222= otvorenie domény zlyhalo
3223= prístup zamietnutý
3259 = KEYSET nie je dostupný
3262 = Nastavenie DNSSEC zlyhalo
3264 = KEYSET je blokovaný

Návratové dáta

Požiadavka nevracia žiadne dáta.

Šablóny

JSON požiadavka:

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

JSON odpoveď (OK):

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

domain-tld-period-check

Použite domain-tld-period-check požiadavka na zistenie, či možno pre TLD nastaviť určité registračné obdobie.

Parametre

tld – TLD
obdobie – počet rokov

Návratové hodnoty

1000 – obdobie možno pre túto doménu použiť
2203 –obdobie nemožno pre túto doménu použiť

Dáta odpovede

Požiadavka nevracia žiadne dáta.

Šablóny

JSON prí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 odpoveď (OK):

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

Bolo to užitočné?

Ďakujeme za spätnú väzbu!

WAPI – Domény

domains-list

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-check

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-create

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-info

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-renew

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-update-ns

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-transfer-check

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-transfer

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-send-auth-info

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

domain-update-keyset

Parametre

Návratové hodnoty

Návratové dáta

Šablóny

domain-tld-period-check

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

Bolo to užitočné?

Obsah článku

Prehliadať kategórie