REST API – Kontakty domén

GET /contacts/check

Kontroluje, či je handle kontaktu voľný na použitie a aký je jeho stav v registri.

Parametre:

• tld – povinný, query, string – TLD, pre ktorú sa kontakt kontroluje
• cname – povinný, query, string – handle (identifikátor) kontaktu
• reg_key – voliteľný, query, string – identifikátor konkrétneho registra (ak TLD podporuje viac registrov/režimov)

Návratové kódy:

• 1000 – kontakt je voľný a použiteľný
• 2201 – neplatná TLD
• 2216 – neplatný formát identifikátora kontaktu
• 2218 – v tomto registri sa kontakty generujú automaticky (handle si nemôžete zvoliť)
• 3228 – register nepodporuje kontakty
• 3231 – kontakt už existuje
• 3233 – kontakt nie je možné použiť
• 3234 – kontakt nie je možné použiť – karanténa
• 3235 – kontakt nie je možné použiť – rezervovaný
• 3236 – kontakt nie je možné použiť – blokovaný
• 3237 – kontakt je už zaregistrovaný u nás
• 4211 – kontrola kontaktu zlyhala – chyba spojenia

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Prí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}

Vráti podrobné informácie o kontakte.

Parametre:

• cname – povinný, path – handle kontaktu
• tld – povinný, query, string – TLD, pod ktorou sa kontakt vyhľadáva
• auth_info – voliteľný, query, string – autorizačný kód kontaktu (ak je uvedený, musí sa zhodovať s kódom nastaveným na objekte, inak sa vráti chyba)
• reg_key – voliteľný, query, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK
• 2201 – nesprávne zadaná TLD
• 2216 – syntaktická chyba identifikátora kontaktu
• 3215 – neplatný autorizačný kód (je uvedený a nezhoduje sa)
• 3228 – register nepodporuje kontakty
• 3229 – chyba pri načítaní kontaktu
• 3236 – kontakt je blokovaný
• 4212 – chyba spojenia
• 5001 – nikto nie je prihlásený

Dáta odpovede:

• contact – objekt s údajmi kontaktu:
  • contact_id, roid, status – identifikátor, ROID a stav kontaktu v registri
  • name, fname, lname, company – meno/krstné meno/priezvisko, prípadne názov firmy
  • addr_street, addr_city, addr_zip, addr_state, addr_country – adresa
  • phone, fax, email, email2 – kontaktné údaje
  • ic, dic, taxpayer – IČO, DIČ, platiteľ DPH
  • reg_owner, reg_creator, reg_update – identifikátory registrátora
  • created_date, updated_date, transfer_date – dátumy vytvorenia/aktualizácie/prenosu
  • disclose – nastavenie zverejňovania údajov (podľa registra)
  • other – ďalšie údaje špecifické pre register

Prí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

Vytvorí nový kontakt domény pre danú TLD.

Parametre:

• tld – povinný, string – TLD, pre ktorú sa kontakt vytvára
• reg_key – voliteľný, string – identifikátor konkrétneho registra
• contact – povinný, object – údaje kontaktu; dostupné polia sa líšia podľa registra, typicky:
  • cname (voliteľné) – požadovaný handle kontaktu; pri registroch, ktoré handle generujú automaticky, ho vynechajte
  • fname, lname – krstné meno a priezvisko (pri fyzickej osobe)
  • company – názov firmy (pri právnickej osobe)
  • addr_street, addr_city, addr_zip, addr_state, addr_country – adresa
  • phone, fax, email, email2 – kontaktné údaje
  • ic, dic, taxpayer – IČO, DIČ, platiteľ DPH
  • ďalšie položky podľa konkrétneho registra

Návratové kódy:

• 1000 – kontakt vytvorený
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – neplatná TLD
• 2216 – neplatný názov kontaktu
• 2218 – v tomto registri sa názvy kontaktov vytvárajú automaticky (vlastný nie je možné zadať)
• 2219–2242 – chýbajúci alebo neplatný formát jednotlivých položiek kontaktu (firma, krstné meno, priezvisko, e-mail, telefón, fax, IČO, DIČ, adresa, región, ďalšie údaje)
• 3228 – register nepodporuje kontakty
• 3230 – vytvorenie kontaktu zlyhalo
• 3231 – názov kontaktu je už použitý
• 3233 – kontakt nie je možné použiť
• 3234 – kontakt nie je možné použiť – karanténa
• 3236 – kontakt nie je možné použiť – blokovaný
• 3237 – kontakt je už zaregistrovaný u nás
• 4211 – kontrola zlyhala – chyba komunikácie
• 4213 – vytvorenie kontaktu zlyhalo – chyba komunikácie

Dáta odpovede:

• cname – handle vytvoreného kontaktu

Prí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

Prenáša kontakt k nám od iného registrátora (iba v registroch, ktoré prenos kontaktov podporujú, napr. CZ.NIC).

Parametre:

• cname – povinný, path – handle kontaktu
• tld – povinný, string – TLD
• auth_info – povinný, string – autorizačný kód kontaktu
• reg_key – voliteľný, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – neplatná TLD
• 2215 – parameter auth_info chýba
• 2216 – neplatný identifikátor kontaktu
• 2244 – táto doména/register nepodporuje prenos kontaktov
• 3229 – kontakt nie je dostupný
• 3237 – kontakt je už zaregistrovaný u nás
• 3240 – chyba autorizácie
• 3241 – prenos zlyhal
• 4216 – prenos zlyhal – chyba spojenia

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Prí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

Odosiela autorizačný kód kontaktu na jeho kontaktný e-mail.

Parametre:

• cname – povinný, path – handle kontaktu
• tld – povinný, string – TLD
• reg_key – voliteľný, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – neplatná TLD
• 2216 – neplatný názov kontaktu
• 2243 – odoslanie autorizačného kódu nie je pre tento kontakt povolené
• 3213 – kontakt nie je dostupný
• 3215 – odoslanie kódu zlyhalo
• 3228 – register nepodporuje kontakty
• 4217 – odoslanie zlyhalo – chyba komunikácie
• 5001 – chyba autentizácie

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Prí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}

Upravuje údaje existujúceho kontaktu. Nie je možné použiť v registroch, kde kontakty nie sú editovateľné (napr. Ascio).

Parametre:

• cname – povinný, path – handle kontaktu
• tld – povinný, string – TLD
• auth_info – voliteľný, string – autorizačný kód kontaktu
• contact – povinný, object – údaje kontaktu na úpravu (rovnaké polia ako pri POST /contacts/create; zmenia sa iba uvedené polia)
• reg_key – voliteľný, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – neplatná TLD
• 2207 – syntaktická chyba
• 2216 – neplatný názov kontaktu
• 2219–2241 – chýbajúci alebo neplatný formát jednotlivých upravovaných položiek (rovnaký rozsah ako pri vytvorení kontaktu)
• 3211 – nepodarilo sa načítať kontakt
• 3238 – chyba autorizácie
• 3239 – úprava zlyhala
• 4202 – kontakt nie je dostupný – chyba spojenia
• 4215 – vykonanie zlyhalo – chyba spojenia

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

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