REST API – Kontakty domén

GET /contacts/check

Kontroluje, zda je handle kontaktu volný k použití a jaký má stav v registru.

Parametry:

• tld – povinný, query, string – TLD, pro kterou se kontakt kontroluje
• cname – povinný, query, string – handle (identifikátor) kontaktu
• reg_key – volitelný, query, string – identifikátor konkrétního registru (pokud daná TLD podporuje více registrů/režimů)

Návratové kódy:

• 1000 – kontakt je volný a použitelný
• 2201 – neplatná TLD
• 2216 – neplatný formát identifikátoru kontaktu
• 2218 – v tomto registru se kontakty generují automaticky (handle nelze zvolit)
• 3228 – registr nepodporuje kontakty
• 3231 – kontakt již existuje
• 3233 – kontakt nelze použít
• 3234 – kontakt nelze použít – karanténa
• 3235 – kontakt nelze použít – rezervovaný
• 3236 – kontakt nelze použít – blokovaný
• 3237 – kontakt je již registrovaný u nás
• 4211 – kontrola kontaktu se nezdařila – chyba spojení

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Příklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/contacts/check?tld=eu&cname=CONTACT'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f1"
}

GET /contacts/{cname}

Vrací podrobné informace o kontaktu.

Parametry:

• cname – povinný, path – handle kontaktu
• tld – povinný, query, string – TLD, pod kterou se kontakt vyhledává
• auth_info – volitelný, query, string – autorizační kód kontaktu (pokud je uveden, musí odpovídat kódu nastavenému na objektu, jinak se vrátí chyba)
• reg_key – volitelný, query, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK
• 2201 – chybně zadaná TLD
• 2216 – chyba syntaxe identifikátoru kontaktu
• 3215 – neplatný autorizační kód (byl uveden a neodpovídá)
• 3228 – registr nepodporuje kontakty
• 3229 – chyba při načítání kontaktu
• 3236 – kontakt je blokovaný
• 4212 – chyba spojení
• 5001 – nikdo není přihlášen

Data odpovědi:

• contact – objekt s údaji kontaktu:
  • contact_id, roid, status – identifikátor, ROID a stav kontaktu v registru
  • name, fname, lname, company – jméno/křestní jméno/příjmení, případně název firmy
  • addr_street, addr_city, addr_zip, addr_state, addr_country – adresa
  • phone, fax, email, email2 – kontaktní údaje
  • ic, dic, taxpayer – IČ, DIČ, plátcovství DPH
  • reg_owner, reg_creator, reg_update – identifikátory registrátora
  • created_date, updated_date, transfer_date – data vytvoření/aktualizace/přeregistrace
  • disclose – nastavení zveřejňování údajů (podle registru)
  • other – doplňující údaje specifické pro daný registr

Příklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/contacts/CONTACT?tld=eu'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f2",
  "data": {
    "contact": {
      "contact_id": "CONTACT",
      "status": "ok",
      "fname": "Esmeralda",
      "lname": "Excavadora",
      "company": null,
      "addr_street": "Street 123",
      "addr_city": "City",
      "addr_zip": "11000",
      "addr_country": "CZ",
      "phone": "+420.777123456",
      "email": "esmeralda@wedos.com",
      "created_date": "2024-01-10",
      "updated_date": null
    }
  }
}

POST /contacts/create

Vytvoří nový kontakt domény pro zadanou TLD.

Parametry:

• tld – povinný, string – TLD, pro kterou se kontakt vytváří
• reg_key – volitelný, string – identifikátor konkrétního registru
• contact – povinný, object – údaje kontaktu; dostupná pole se liší podle registru, obvykle:
  • cname (volitelný) – požadovaný handle kontaktu; u registrů, které handle generují automaticky, jej vynechte
  • fname, lname – křestní jméno a příjmení (u fyzické osoby)
  • company – název firmy (u právnické osoby)
  • addr_street, addr_city, addr_zip, addr_state, addr_country – adresa
  • phone, fax, email, email2 – kontaktní údaje
  • ic, dic, taxpayer – IČ, DIČ, plátcovství DPH
  • další položky podle konkrétního registru

Návratové kódy:

• 1000 – kontakt vytvořen
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – neplatná TLD
• 2216 – neplatný název kontaktu
• 2218 – v tomto registru se názvy kontaktů vytvářejí automaticky (vlastní nelze zadat)
• 2219–2242 – chybějící nebo neplatný formát jednotlivých položek kontaktu (firma, křestní jméno, příjmení, e-mail, telefon, fax, IČ, DIČ, adresa, region, další údaje)
• 3228 – registr nepodporuje kontakty
• 3230 – vytvoření kontaktu se nezdařilo
• 3231 – název kontaktu je již použitý
• 3233 – kontakt nelze použít
• 3234 – kontakt nelze použít – karanténa
• 3236 – kontakt nelze použít – blokovaný
• 3237 – kontakt je již registrovaný u nás
• 4211 – kontrola se nezdařila – chyba komunikace
• 4213 – vytvoření kontaktu se nezdařilo – chyba komunikace

Data odpovědi:

• cname – handle vytvořeného kontaktu

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/create' \
  --data '{
    "tld": "eu",
    "contact": {
      "fname": "Esmeralda",
      "lname": "Excavadora",
      "addr_street": "Street 123",
      "addr_city": "City",
      "addr_zip": "11000",
      "addr_country": "CZ",
      "email": "esmeralda@wedos.com",
      "phone": "+420.777123456"
    }
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f3",
  "data": {
    "cname": "CONTACT"
  }
}

POST /contacts/{cname}/transfer

Přeregistruje kontakt k nám od jiného registrátora (pouze u registrů, které přeregistraci kontaktů podporují, např. CZ.NIC).

Parametry:

• cname – povinný, path – handle kontaktu
• tld – povinný, string – TLD
• auth_info – povinný, string – autorizační kód kontaktu
• reg_key – volitelný, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – neplatná TLD
• 2215 – parametr auth_info chybí
• 2216 – neplatný identifikátor kontaktu
• 2244 – tato doména/registr nepodporuje přeregistraci kontaktů
• 3229 – kontakt není dostupný
• 3237 – kontakt je již registrovaný u nás
• 3240 – chyba autorizace
• 3241 – přeregistrace se nezdařila
• 4216 – přeregistrace se nezdařila – chyba spojení

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT/transfer' \
  --data '{"tld": "cz", "auth_info": "AUTHCODE123"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f4"
}

POST /contacts/{cname}/auth-info/send

Odešle autorizační kód kontaktu na jeho kontaktní e-mail.

Parametry:

• cname – povinný, path – handle kontaktu
• tld – povinný, string – TLD
• reg_key – volitelný, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – neplatná TLD
• 2216 – neplatný název kontaktu
• 2243 – odeslání autorizačního kódu není pro tento kontakt povoleno
• 3213 – kontakt není dostupný
• 3215 – odeslání kódu se nezdařilo
• 3228 – registr nepodporuje kontakty
• 4217 – odeslání se nezdařilo – chyba komunikace
• 5001 – chyba autentizace

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT/auth-info/send' \
  --data '{"tld": "eu"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f5"
}

PATCH /contacts/{cname}

Upraví údaje existujícího kontaktu. Nelze použít u registrů, kde kontakty nelze editovat (např. Ascio).

Parametry:

• cname – povinný, path – handle kontaktu
• tld – povinný, string – TLD
• auth_info – volitelný, string – autorizační kód kontaktu
• contact – povinný, object – údaje kontaktu k úpravě (stejná pole jako u POST /contacts/create; mění se pouze uvedená pole)
• reg_key – volitelný, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – neplatná TLD
• 2207 – chyba syntaxe
• 2216 – neplatný název kontaktu
• 2219–2241 – chybějící nebo neplatný formát jednotlivých upravovaných položek (stejný rozsah jako u vytvoření kontaktu)
• 3211 – nepodařilo se načíst kontakt
• 3238 – chyba autorizace
• 3239 – úprava se nezdařila
• 4202 – kontakt není dostupný – chyba spojení
• 4215 – provedení se nezdařilo – chyba spojení

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Příklad:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT' \
  --data '{"tld": "eu", "contact": {"email": "esmeralda-new@wedos.com"}}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f6"
}