WAPI - NSSET - Znalostní báze WEDOS

WAPI – NSSET

23. 10. 2023 WAPI (API rozhraní)

Pokud jste WAPI ještě nepoužívali, projděte si nejprve článek WAPI v kostce (manuál).

Tento návod řeší příkazy WAPI pro práci s NSSETem, který používají pouze domény CZ. Návod na práci s DNS najdete v článku WAPI – DNS.

V tomto článku najdete informace k následujícím příkazům:

nsset-check – kontrola dostupnosti NSSETu
nsset-info – informace o NSSETu
nsset-create – vytvoření NSSETu
nsset-update – úprava dat NSSETu
nsset-transfer – převod NSSETu od jiného registrátora
nsset-send-auth-info – zaslání autorizačního kódu NSSETu na kontaktní e-mail

nsset-check

Příkazem nsset-check ověříte, zda je název NSSETu volný k registraci, nebo je již obsazen, případně je v nějakém jiném stavu.

Návratové hodnoty

1000 – NSSET je dostupný k registraci
2201 – neplatné TLD
2247 – nepodoprovaný formát NSSETu
3242 – NSSET je nedostupný
3245 – NSSET je již zaregistrován
3246 – nedostupný
3247 – nedostupný
3248 – nedostupný – karanténa
3249 – nedostupný – rezervován
3250 – nedostupný – blokován
3251 – již zaregistrováno (u nás)
4218 – odeslání selhalo – chyba komunikace

nsset-check JSON

JSON příkaz:

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "nsset-check",
    "clTRID": "vlastní id kód",
    "data": {
      "tld": "cz",
      "name": "název NSSETu"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "nsset-check"
  }
}

nsset-check XML

XML dotaz:

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>nsset-check</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <tld>cz</tld>
    <name>název NSSETu</name>
  </data>
</request>

XML odpověď:

<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>nsset-check</command>
</response>

nsset-info

Příkazem nsset-info stáhnete informace o daném NSSETu.

Návratové hodnoty

1000 – OK
2201 – neplatné TLD
2209 – chyba syntaxe
2247 – nepodoprovaný formát NSSETu
3214 – chyba – NSSET nenačten
3242 – NSSET je nedostupný
4204 – chyba spojení, opakujte později

Návratová data

V případě úspěchu vrací příkaz v uzlu data element nsset s těmito položkami:

name – název NSSETu
status – stav
reg_owner – aktuální registrátor
reg_creator – registrátor, který NSSET vytvořil
reg_update – registrátor, který provedl poslední změnu
created_date – vytvořeno
updated_date – datum poslední změny
transfer_date – datum přeregistrace k jinému registrátorovi
tech_c – technický kontakt NSSETu
dns – seznam DNS serverů
server
- name – jméno serveru
- addr_ipv4 – IPv4 adresa serveru
- addr_ipv6 – IPv6 adresa serveru

nsset-info JSON

JSON příkaz:

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "nsset-info",
    "clTRID": "vlastní id kód",
    "data": {
      "tld": "cz",
      "name": "název NSSETu"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "nsset-info",
    "data": {
      "nsset": {
        "name": "Název NSSETu",
        "status": "ok",
        "reg_owner": "aktuální registrátor",
        "reg_creator": "autor NSSETu",
        "reg_update": "registrátor poslední změny",
        "created_date": "datum a čas založení",
        "updated_date": "datum a čas poslední změny",
        "transfer_date": "datum a čas přeregistrace",
        "tech_c": "ID technického kontaktu",
        "dns": {
          "server1": {
            "name": "název DNS serveru",
            "addr_ipv4": "IPv4 adresa DNS serveru",
            "addr_ipv6": "IPv6 adresa DNS serveru"
          }
        }
      }
    }
  }
}

nsset-info XML

XML dotaz:

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>nsset-info</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <tld>cz</tld>
    <name>název NSSETu</name>
  </data>
</request>

XML odpověď:

<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>nsset-info</command>
  <data>
    <nsset>
      <name>Název NSSETu</name>
      <status>ok</status>
      <reg_owner>aktuální registrátor</reg_owner>
      <reg_creator>autor NSSETu</reg_creator>
      <reg_update>registrátor poslední změny</reg_update>
      <created_date>datum a čas založení</created_date>
      <updated_date>datum a čas poslední změny</updated_date>
      <transfer_date>datum a čas přeregistrace</transfer_date>
      <tech_c>ID technického kontaktu</tech_c>
      <dns>
        <server>
          <name>název DNS serveru</name>
          <addr_ipv4>IPv4 adresa DNS serveru</addr_ipv4>
          <addr_ipv6>IPv6 adresa DNS serveru</addr_ipv6>
        </server>
      </dns>
    </nsset>
  </data>
</response>

Příkaz nsset-create slouží pro vytvoření nového NSSETu. NSSET obsahuje seznam ns serverů, každý server obsahuje položku name a případně také jeho IP adresy. Dále můžete nastavit kontakt techika, pokud ho nezadáte, nastaví se výchozí (WEDOS).

Parametry

tld – TLD
name – název NSSETu
dns – seznam ns serverů, každá položka server obsahuje informace o daném ns serveru
- server
  - name – název
  - addr_ipv4 – IPv4 adresa
  - addr_ipv6 – IPv6 adresa
tech_c – kontakt technika – nepovinný parametr

Návratové hodnoty

1000 – OK, NSSET vytvořen
2201 – chybně zadaná TLD
2210 – neplatný formát pole ns serverů
2211 – příliš mnoho ns serverů
2216 – chybná syntaxe kontaktu technika
2247 – nepodoprovaný formát NSSETu
3228 – není podpora práce s kontakty
3229 – chyba načtení kontaktu
3242 – NSSET je nedostupný
3244 – vytvoření NSSETu selhalo
3245 – NSSET je již zaregistrován
3246 – nedostupný
3247 – nedostupný
3248 – nedostupný – karanténa
3249 – nedostupný – rezervován
3250 – nedostupný – blokován
3251 – již zaregistrováno
4212 – chyba spojení
4218 – kontrola selhala – chyba komunikace
4219 – vytvoření selhalo – chyba komunikace

Návratová data

V případě úspěchu vrací příkaz v uzlu data toto:

nsset – název vytvořeného NSSETu

Šablony

nsset-create JSON

JSON příkaz:

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "nsset-create",
    "clTRID": "vlastní id kód",
    "data": {
      "tld": "cz",
      "name": "název NSSETu",
      "dns": {
        "server1": {
          "name": "doménový název DNS serveru",
          "addr_ipv4": "IPv4 adresa serveru",
          "addr_ipv6": "IPv4 adresa serveru"
        }
      },
      "tech_c": "ID technického kontaktu"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "nsset-create",
    "data": {
      "nsset": "Název NSSETu"
    }
  }
}

nsset-create XML

XML dotaz:

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>nsset-create</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <tld>cz</tld>
    <name>název NSSETu</name>
    <dns>
      <server>
        <name>adresa DNS serveru</name>
      </server>
    </dns>
    <tech_c>ID technického kontaktu</tech_c>
  </data>
</request>

XML odpověď:

<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>nsset-create</command>
  <data>
    <nsset>Název NSSETu</nsset>
  </data>
</response>

nsset-update

Příkazem nsset-update upravíte již existující NSSET. Starý záznam se kompletně přepíše, zadejte tedy všechny položky.

Parametry

tld – TLD
name – název NSSETu
dns – seznam ns serverů, každá položka server obsahuje informace o daném ns serveru
- server
  - name – název
  - addr_ipv4 – IPv4 adresa
  - addr_ipv6 – IPv6 adresa
tech_c – kontakt technika – nepovinné

Návratové hodnoty

1000 – OK, NSSET upraven
2201 – chybně zadaná TLD
2209 – chyba syntaxe
2210 – neplatný formát seznamu dns serverů
2211 – příliš mnoho dns serverů
2216 – chybná syntaxe kontaktu
2247 – neplatný NSSET
3214 – chyba – NSSET nenačten
3228 – není podpora práce s kontakty
3229 – chyba načtení kontaktu
3242 – NSSET není touto doménou podporován
3252 – chyba autorizace
3254 – úprava NSSETu selhala
4204 – NSSET je nedostupný – chyba spojení
4220 – úprava NSSETu selhala – chyba spojení
4212 – kontakt je nedostupný – chyba spojení

Návratová data

Příkaz nevrací žádná data.

Šablony

nsset-update JSON

JSON příkaz:

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "nsset-update",
    "clTRID": "vlastní id kód",
    "data": {
      "tld": "cz",
      "name": "název NSSETu",
      "dns": {
        "server1": {
          "name": "adresa DNS serveru",
          "addr_ipv4": "IPv4 adresa serveru",
          "addr_ipv6": "IPv4 adresa serveru"
        }
      },
      "tech_c": "ID technického kontaktu"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "nsset-update"
  }
}

nsset-update XML

XML dotaz:

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>nsset-update</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <tld>cz</tld>
    <name>název NSSETu</name>
    <dns>
      <server>
        <name>adresa DNS serveru</name>
      </server>
    </dns>
    <tech_c>ID technického kontaktu</tech_c>
  </data>
</request>

XML odpověď:

<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>nsset-update</command>
</response>

nsset-transfer

Příkaz nsset-transfer změní registrátora NSSETu na WEDOS.

Parametry

tld – TLD
name – název NSSETu
auth_info – autorizační heslo k NSSETu

Návratové hodnoty

1000 – OK
2100 – povinný parametr chybí
2101 – neplatné vstupní parametry
2201 – nepodporovaná TLD
2209 – chyba syntaxe
2215 – chybí auth_info
2247 – neplatný název NSSETu
2249 – pro tuto TLD není transfer NSSETu povolen
3214 – chyba – NSSET nenačten
3242 – NSSET není podporován
3251 – NSSET je již u cílového registrátora zaregistrován
3255 – chyba autorizace
3256 – transfer NSSETu selhal
4204 – NSSET nenačten – chyba spojení
4221 – transfer NSSETu selhal – chyba spojení

Návratová data

Příkaz nevrací žádná data.

Šablony

nsset-transfer JSON

JSON příkaz:

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "nsset-transfer",
    "clTRID": "vlastní id kód",
    "data": {
      "tld": "cz",
      "name": "název NSSETu",
      "auth_info": "autorizační heslo NSSETu"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "nsset-transfer"
  }
}

nsset-transfer XML

XML dotaz:

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>nsset-transfer</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <tld>cz</tld>
    <name>název NSSETu</name>
    <auth_info>autorizační heslo NSSETu</auth_info>
  </data>
</request>

XML odpověď:

<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>nsset-transfer</command>
</response>

nsset-send-auth-info

Příkaz nsset-send-auth-info zašle autorizační heslo NSSETu na e-mail technického kontaktu NSSETu.

Parametry

tld – TLD
name – název NSSETu

Návratové hodnoty

1000 – OK, auth_info odesláno na kontaktní e-mail
2201 – nepodporované TLD
2209 – chyba syntaxe NSSETu
2216 – chybná syntaxe kontaktu
2243 – pro tento NSSET není povoleno odeslání autorizačního kódu
2247 – nepodoprovaný formát NSSETu
3214 – chyba – NSSET nenačten
3217 – odeslání autorizačního kódu selhalo
3228 – není podpora práce s kontakty
3229 – chyba načtení kontaktu
3242 – NSSET je nedostupný
3257 – odeslání selhalo, NSSET je nedostupný
4204 – NSSET není dostupný – chyba spojení
4212 – kontakt není dostupný – chyba spojení
4222 – odeslání selhalo – chyba spojení

Návratová data

Příkaz nevrací žádná data.

Šablony

nsset-send-auth-info JSON

JSON příkaz:

{
  "request": {
    "user": "váš@login.tld",
    "auth": "vygenerovaný autorizační řetězec",
    "command": "nsset-send-auth-info",
    "clTRID": "vlastní id kód",
    "data": {
      "tld": "cz",
      "name": "název NSSETu"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF čas",
    "clTRID": "vlastní id kód",
    "svTRID": "id kód serveru",
    "command": "nsset-send-auth-info"
  }
}

nsset-send-auth-info XML

XML dotaz:

<request>
  <user>váš@login.tld</user>
  <auth>vygenerovaný autorizační řetězec</auth>
  <command>nsset-send-auth-info</command>
  <clTRID>vlastní id kód</clTRID>
  <data>
    <tld>cz</tld>
    <name>název NSSETu</name>
  </data>
</request>

XML odpověď:

<response>
  <code>1000</code>
  <result>OK</result>
  <timestamp>UTF čas</timestamp>
  <clTRID>vlastní id kód</clTRID>
  <svTRID>id kód serveru</svTRID>
  <command>nsset-send-auth-info</command>
</response>

Pomohl Vám návod?

Děkujeme za zpětnou vazbu!

Hledání

Znalostní báze

Nejnovější návody