REST API – WEDOS.protection Domény

WEDOS REST API je stále vo vývoji. Prístup a funkcie sa môžu bez predchádzajúceho upozornenia zmeniť.

Tento článok čiastočne popisuje WEDOS.protection endpoint WEDOS REST API. Služby WEDOS.protection a Členovia majú vlastné články. Pre WEDOS API (WAPI) pozri WAPI – WEDOS Protection.

Základné informácie o WEDOS REST API nájdete v článku WEDOS REST API Manuál.

V tomto článku nájdete nasledujúce informácie:

Prístup k WGP endpointu

WGP HTTP REST API v2 slúži na správu domén, služieb a pozvánok na spolusprávu vo WEDOS.protection (WGP).

Základné URL a autentizácia

Základné URL pre WGP endpointy je: https://api.wedos.com/v2

Na autentizáciu slúži iba OAuth2: do hlavičky požiadavky vložte platný prístupový token (Authorization: Bearer <TOKEN>) so scope wgp . Bez platného tokenu vracia API chybu 2000.

Môžete pridať parameter example=1 ku ktorémukoľvek endpointu ako GET parameter (?example=1 pre endpointy bez vlastných GET parametrov, inak &example=1). API potom pre dané volanie vráti ukážkový príkaz curl bez nutnosti zadávať skutočné parametre. Aj v tomto režime je vyžadované platné overenie.

Prehľad endpointov

MetódaEndpointPopis
GET/domains/{domain}Detail jednej domény vo WGP
GET/domains/templatesZoznam šablónových domén pre daný variant služby
POST/domains/createNastavenie novej domény vo WGP
POST/domains/infoDetail jednej alebo viacerých domén vo WGP
POST/domains/{domain}/create/retryOpakovanie nastavenia domény po chybe
POST/domains/{domain}/delete-orderZmazanie nedokončenej objednávky domény

Formát odpovede

Odpoveďou API je vždy objekt JSON s kľúčmi code (návratový kód), msg (textový popis), request_id (identifikátor požiadavky) a prípadne data (vrátené dáta pri úspechu).

Všeobecné návratové kódy platné pre všetky endpointy (REST vrstva, nezávisle od konkrétnej operácie):

  • 1000 – úspech (OK)
  • 2000 – chýba alebo je neplatná autentizácia (OAuth2 Bearer token)
  • 2004 – prekročená maximálna veľkosť požiadavky (URL alebo telo požiadavky)
  • 4000 – neznáma/nepodporovaná metóda API (volaná kombinácia HTTP metódy a cesty neexistuje)
  • 4001 – overenie vstupu zlyhalo
  • 4005 – pre aktuálny endpoint nie je v režime example=1 k dispozícii žiadny príklad
  • 6000 – interná chyba pri inicializácii podkladového WAPI príkazu

Každý endpoint navyše vracia vlastné biznis kódy špecifické pre danú operáciu (zodpovedajúce podkladovému WAPI príkazu). Tie sú uvedené v časti Návratové kódy pri každom endpointe.

GET /domains/{domain}

Vracia informácie o jednej doméne pripojenej k WGP – kombináciu dát z externej administrácie WEDOS Global Protection a internej databázy WEDOS.

Parametre:

  • domain – povinný, path – názov domény

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2101 – neplatný formát parametra
  • 2202 – neplatný alebo nepodporovaný formát názvu domény
  • 2292 – doména pre tento zákaznícky účet vo WGP neexistuje
  • 2400 – interná chyba – neregistrovaný návratový kód z WGP API (pozri Poznámky)
  • 2418 – chýba TXT záznam pre doménu v stave Pending_TXT .

Dáta odpovede:

  • wgp – dáta domény z externej administrácie WGP (napr. stav domény, príznak admin účtu a ďalšie; položky wedos_client_id a cms sa z odpovede odstraňujú)
  • service – dáta domény z internej databázy: ID, name, num, user_id, lang, currency, fakturačné (cli_*) a vlastnícke (own_*) kontaktné údaje, status, expiration

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "wgp": {
      "domain": "domain1.tld",
      "state": "active",
      "user_admin": false
    },
    "service": {
      "ID": 435,
      "name": "domain1.tld",
      "num": "2026123456",
      "user_id": 10234,
      "lang": "cs",
      "currency": "CZK",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  }
}

GET /domains/templates

Vracia stránkovaný zoznam šablónových domén dostupných pre daný variant služby WGP. Použite ho ako zdroj template_domain_id pri nastavovaní domény alebo replikácii nastavení.

Parametre:

  • variant_id – povinný, query – ID variantu služby WGP (pozri číselník hosting_wedos_protection.variants )
  • per_page – voliteľný, query – počet záznamov na stránku; predvolene 15, hodnota -1 vráti všetky záznamy
  • page – voliteľný, query – číslo stránky; predvolene 1
  • locale – voliteľný, query – jazyk stránkovania, povolené hodnoty cs, en; predvolene en
  • search – voliteľný, query – vyhľadávací reťazec v stĺpcoch custom_name, name

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter (variant_id)
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • data – pole šablónových domén; každá položka obsahuje id, custom_name, name, url
  • per_page, total, last_page, from, to – podrobnosti stránkovania
  • first_page_url, prev_page_url, next_page_url, last_page_url, path – odkazy na jednotlivé stránky
  • links – pole prvkov stránkovania (url, label, active)

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/templates?variant_id=1'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "data": [
      {
        "id": 123,
        "custom_name": "Sample e-shop",
        "name": "template-eshop.wedos.com",
        "url": "https://template-eshop.wedos.com"
      }
    ],
    "per_page": 15,
    "total": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "path": "https://api.wedos.com/v2/wgp/domains/templates",
    "first_page_url": "https://api.wedos.com/v2/wgp/domains/templates?page=1",
    "prev_page_url": null,
    "next_page_url": null,
    "last_page_url": "https://api.wedos.com/v2/wgp/domains/templates?page=1",
    "links": [
      {"url": null, "label": "&laquo; Previous", "active": false},
      {"url": "https://api.wedos.com/v2/wgp/domains/templates?page=1", "label": "1", "active": true},
      {"url": null, "label": "Next &raquo;", "active": false}
    ]
  }
}

POST /domains/info

Vracia informácie o jednej alebo viacerých doménach vo WGP (ekvivalent GET /domains/{domain}, ale v tele požiadavky môžete zadať niekoľko domén oddelených čiarkami).

Parametre:

  • domain – povinný – názov domény alebo viacero názvov oddelených čiarkami (napr. "domain1.tld,domain2.tld")

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2101 – neplatný formát parametra
  • 2202 – neplatný alebo nepodporovaný formát názvu domény
  • 2292 – doména pre tento zákaznícky účet vo WGP neexistuje
  • 2400 – interná chyba – neregistrovaný návratový kód z WGP API
  • 2418 – chýba TXT záznam pre doménu v stave Pending_TXT .

Dáta odpovede: Pri jednej doméne rovnaká štruktúra ako GET /domains/{domain} (kľúče wgp a service). Pri viacerých doménach je odpoveďou objekt s kľúčmi podľa názvu domény, kde každá položka má opäť štruktúru wgp a service .

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/domains/info' \
  --data '{"domain":"domain1.tld,domain2.tld"}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain1.tld": {
      "wgp": {"domain": "domain1.tld", "state": "active", "user_admin": false},
      "service": {"ID": 435, "name": "domain1.tld", "status": "active", "expiration": "2027-10-01 00:00:00"}
    },
    "domain2.tld": {
      "wgp": {"domain": "domain2.tld", "state": "active", "user_admin": false},
      "service": {"ID": 436, "name": "domain1.tld", "status": "active", "expiration": "2027-03-15 00:00:00"}
    }
  }
}

POST /domains/create

Nastaví novú doménu vo WGP. Možno ho použiť aj na obnovenie domény, ktorá bola pozastavená (stav disabled), pretože jej nastavenie nebolo po vytvorení včas dokončené.

Parametre:

  • domain – povinný – názov domény
  • variant_id – povinný, číslo – ID variantu služby (pozri číselník hosting_wedos_protection.variants )
  • period_id – povinný, číslo – ID obdobia predplatného
  • upstream_ips – voliteľný, pole – pole IP adries, ktoré sa nebudú prekladať na WGP
  • template_domain_id – voliteľný, číslo – ID šablónovej domény použitej na konfiguráciu novej domény
  • mode – voliteľný, reťazec – režim domény, povolené hodnoty ns alebo cname

Návratové kódy:

  • 1000 – OK (obnovenie predtým pozastavenej domény zo stavu disabled )
  • 1001 – požiadavka prijatá, nastavenie domény sa spracováva
  • 2101 – neplatná hodnota parametra
  • 2202 – neplatný alebo nepodporovaný formát názvu domény
  • 2203 – neplatná hodnota parametra period_id
  • 2272 – neplatný formát IP adresy (upstream_ips)
  • 2273 – neplatná hodnota parametra variant_id
  • 2276 – nepodporovaná TLD
  • 2277 – explicitné www. v názve domény nie je povolené
  • 2278 – služba pre túto doménu už existuje
  • 2279 – zálohový účet je zablokovaný
  • 2281 – zálohový účet nie je aktívny
  • 2282 – zo zálohového účtu nemožno platiť v danej mene
  • 2283 – nedostatočný zostatok na zálohovom účte
  • 2284 – chyba v kontaktných údajoch zálohového účtu
  • 2285 – nesprávne nastavenie fakturácie s DPH/bez DPH
  • 2291 – doména už pre tento zákaznícky účet vo WGP existuje
  • 2293 – nemožno zistiť zostatok kreditu na zálohovom účte
  • 2294 – nemožno zistiť cenu služby
  • 2416 – neplatný režim domény (mode)
  • 2417 – neplatný alebo nepodporovaný formát názvu subdomény
  • 2422 – nemožno určiť typ účtu (admin/zákazník)
  • 2423 – interná chyba pri volaní WGP API
  • ďalšie chybové kódy špecifické pre operáciu (napr. validácia replikácie šablónovej domény 2401–2405)

Dáta odpovede:

  • WGP_ID – ID domény vo WGP
  • domain – názov domény
  • order_num – číslo objednávky (ak doména nie je nastavená zadarmo alebo admin účtom; aj pri obnovení zo stavu disabled )
  • currency, amount – mena a suma odpísaná zo zálohového účtu
  • acc_amount_before, acc_amount_current – zostatok zálohového účtu pred platbou a po nej
  • desc – popis (prítomný iba pri obnovení domény zo stavu disabled )

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/domains/create' \
  --data '{"domain":"domain1.tld","variant_id":1,"period_id":1,"mode":"ns"}'
{
  "code": 1001,
  "msg": "Request pending",
  "request_id": "a1b2c3d4",
  "data": {
    "WGP_ID": 98765,
    "domain": "domain1.tld",
    "order_num": "2026123456",
    "currency": "CZK",
    "amount": -499,
    "acc_amount_before": 1500,
    "acc_amount_current": 1001
  }
}

POST /domains/{domain}/create/retry

Zopakuje nastavenie domény, ktoré skončilo chybou (dostupné iba pre určité stavy domény, napr. error_crt).

Parametre:

  • domain – povinný, path – názov domény

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2292 – doména pre tento zákaznícky účet vo WGP neexistuje
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • domain – názov domény
  • domain_id – ID domény vo WGP
  • wedos_client_id – ID klienta vo WGP

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld/create/retry'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234
  }
}

POST /domains/{domain}/delete-order

Zmaže nedokončenú objednávku domény – stav, keď doména uviazla vo WGP bez možnosti dokončiť aktiváciu a lokálna služba ešte neexistuje.

Parametre:

  • domain – povinný, path – názov domény

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2292 – doména nebola pre tento zákaznícky účet vo WGP nájdená
  • 2400 – interná chyba
  • 2410 – služba nenájdená
  • 2421 – služba WGP už existuje, doména nebude odstránená

Dáta odpovede:

  • domain – názov domény
  • domain_id – ID domény vo WGP
  • wedos_client_id – ID klienta vo WGP

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld/delete-order'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234
  }
}

Bolo to užitočné?

Ďakujeme za vašu spätnú väzbu!
Všeobecné selektory
Iba presné zhody
Hľadať v názve
Hľadať v obsahu
Selektory typov príspevkov
Obsah článku
Prehliadať kategórie