REST API – WEDOS.protection Služby

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. Domény 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/servicesZoznam vašich samostatných služieb WGP
POST/services/{service_id}/cache/purgeVyprázdnenie CDN cache
POST/services/{service_id}/renewPredĺženie služby
POST/services/{service_id}/template-replicateReplikácia nastavení zo šablónovej domény
PATCH/services/{service_id}Zmena variantu/obdobia predplatného služby
DELETE/services/{service_id}Zmazanie/ukončenie služby

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 /services

Vracia zoznam vlastných samostatných služieb WEDOS Global Protection prihláseného OAuth2 používateľa (vytvorených priamo ako služba WGP, tabuľka hosting_wedos_protection).

Parametre:

  • status – voliteľný, query – filter podľa konkrétneho stavu služby (hodnota sa neoveruje voči číselníku stavov)

Návratové kódy:

  • 1000 – OK

Dáta odpovede: Pole služieb; každá položka obsahuje ID, name, status, expiration.

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services?status=active'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": [
    {
      "ID": 435,
      "name": "domain1.tld",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  ]
}

POST /services/{service_id}/cache/purge

Vyprázdni CDN cache pre doménu pripojenú k WGP. Môže sa týkať buď samostatnej služby WGP, alebo domény s WGP ako doplnkovou službou (hosting_domain); typ služby sa nastavuje parametrom service_type .

Parametre:

  • service_id – povinný, path – ID lokálnej služby
  • service_type – voliteľný – typ služby, hosting_wedos_protection (predvolené) alebo hosting_domain
  • limiter_decay – voliteľný, číslo – čas v sekundách, počas ktorého je opakované vyprázdnenie obmedzené; predvolene 5
  • limiter_reset – voliteľný, bool – zrušenie aktuálneho obmedzenia; predvolene false

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2101 – neplatná hodnota parametra
  • 2406 – doména/služba nenájdená
  • 2415 – obmedzovač ešte beží – vyprázdnenie teraz nemožno zopakovať
  • 3223 – služba patrí inému zákazníckemu účtu
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • domain – názov domény
  • domain_id – ID domény vo WGP
  • domain_tld – TLD domény
  • service_id – ID služby
  • wedos_client_id – ID klienta vo WGP
  • limiter_available_in – o koľko sekúnd možno funkciu znova použiť (dokumentované iba pre chybu 2415; aktuálna implementácia však pri chybe nevracia časť data, pozri Poznámky)

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/cache/purge' \
  --data '{"limiter_decay":5,"limiter_reset":0}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "domain_tld": "tld",
    "service_id": 435,
    "wedos_client_id": 10234
  }
}

POST /services/{service_id}/renew

Predĺži službu WGP o ďalšie fakturačné obdobie.

Parametre:

  • service_id – povinný, path – ID služby

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2101 – neplatná hodnota parametra
  • 2152 – predĺženie nie je v aktuálnom stave služby povolené
  • 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
  • 2293 – nemožno zistiť zostatok kreditu na zálohovom účte
  • 2297 – nemožno zistiť, či zálohový účet zahŕňa DPH
  • 2406 – služba nenájdená
  • 2409 – predĺženie služby sa nepodarilo

Dáta odpovede:

  • service_id – ID služby
  • name – názov domény
  • date_from, date_to – dátumy platnosti nového obdobia
  • fakt_order_num – číslo objednávky predĺženia
  • currency – mena zálohového účtu
  • price – suma za predĺženie
  • credit – zostatok zálohového účtu po platbe (null pri službách FREE/TRIAL)

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435/renew'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "service_id": 435,
    "name": "domain1.tld",
    "date_from": "2027-10-01",
    "date_to": "2028-10-01",
    "fakt_order_num": "2026123457",
    "currency": "CZK",
    "price": 499,
    "credit": 502
  }
}

POST /services/{service_id}/template-replicate

Replikuje (aplikuje) nastavenia šablónovej domény na existujúcu doménu/službu WGP.

Parametre:

  • service_id – povinný, path – ID služby, na ktorú sa nastavenia replikujú
  • template_domain_id – povinný – ID šablónovej domény (pozri GET /domains/templates)
  • service_type – voliteľný – typ služby, hosting_wedos_protection (predvolené) alebo hosting_domain

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2101 – neplatná hodnota parametra
  • 2401 – neplatná doména pre replikáciu
  • 2402 – neplatná šablónová doména
  • 2403 – nezhoda používateľa medzi doménou a šablónovou doménou
  • 2404 – nezhoda programu predplatného medzi doménou a šablónovou doménou
  • 2405 – dosiahnutý denný limit replikácií
  • 2406 – doména/služba nenájdená
  • 2407 – šablónová doména nenájdená
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • domain – názov domény
  • domain_id – ID domény
  • service_id – ID služby
  • service_type – typ služby
  • template_domain_id – ID použitej šablónovej domény
  • replications_count – počet doteraz vykonaných replikácií
  • replications_limit – maximálny povolený počet replikácií

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/template-replicate' \
  --data '{"template_domain_id":123}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "template_domain_id": 123,
    "replications_count": 2,
    "replications_limit": 5
  }
}

PATCH /services/{service_id}

Zmení variant a/alebo obdobie predplatného existujúcej služby WGP.

Parametre:

  • service_id – povinný, path – ID služby
  • new_variant_id – voliteľný, číslo – nový variant služby
  • new_period_id – voliteľný, číslo – nové obdobie predplatného

Treba zadať aspoň jeden z parametrov new_variant_id/new_period_id .

Návratové kódy:

  • 1000 – OK
  • 2100 – chýba povinný parameter
  • 2101 – neplatná hodnota parametra
  • 2203 – neplatná hodnota parametra new_period_id
  • 2273 – neplatná hodnota parametra new_variant_id
  • 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
  • 2293 – nemožno zistiť zostatok kreditu na zálohovom účte
  • 2294 – nemožno zistiť cenu služby
  • 2406 – doména/služba nenájdená
  • 2408 – parameter new_variant_id alebo new_period_id chýba (nebol zadaný ani jeden)
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • domain – názov domény
  • domain_id – ID domény
  • wedos_client_id – ID klienta vo WGP
  • service_id – ID služby
  • service_type – typ služby
  • variant_id – aktuálne ID variantu služby po zmene
  • period_id – aktuálne ID obdobia predplatného po zmene
  • dirty – príznak, či k zmene skutočne došlo (0 = bez zmeny, 1 = zmenené)

Príklad:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435' \
  --data '{"new_variant_id":2,"new_period_id":1}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "variant_id": 2,
    "period_id": 1,
    "dirty": 1
  }
}

DELETE /services/{service_id}

Zmaže/ukončí službu WGP na žiadosť zákazníka.

Parametre:

  • service_id – povinný, path – ID služby
  • force – voliteľný, query, 0/1 – vynúti zmazanie aj vtedy, keď WGP nemá k dispozícii token na prepísanie DNS (obnovenie pôvodných hodnôt A/AAAA záznamov)

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á
  • 2411 – nie je k dispozícii token na prepísanie DNS
  • 2412 – požiadavka API na prepísanie DNS zlyhala
  • 2413 – príkaz nemožno vykonať, WGP nemá oprávnenie manipulovať s DNS domény (force=1 je potrebné)
  • 2414 – pre WGP neexistuje token a parameter force nebol zadaný
  • 3223 – služba patrí inému zákazníckemu účtu

Dáta odpovede:

  • domain – názov domény
  • domain_id – ID domény
  • wedos_client_id – ID klienta vo WGP
  • service_id – ID služby
  • service_type – typ služby
  • wdns_data – pole vykonaných zmien DNS záznamov (IP adresy, ktoré sa po zrušení WGP prestanú prekladať cez WGP)

Príklad:

curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435?force=1'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "wdns_data": []
  }
}

Poznámky

  • GET /services vracia iba samostatné služby WGP. Domény, ktoré majú WGP pripojené ako doplnkovú službu k inej službe, v tomto zozname nie sú a neexistuje pre ne podobný endpoint so zoznamom.
  • POST /services/{service_id}/cache/purge a POST /services/{service_id}/template-replicate sa adresujú priamo cez service_id (nie cez doménu) a podporujú parameter service_type, ktorý rozlišuje medzi samostatnou službou WGP a doménou s WGP ako doplnkovou službou. Zodpovedajúci príkaz WAPI si vlastníctvo vyhľadá sám podľa user_id.
  • Pri POST /services/{service_id}/cache/purge dokumentačný komentár funkcie cmd_purge_cache() spomína aj pole limiter_available_in v dátach odpovede pre chybu 2415, no aktuálna implementácia v tomto prípade vracia iba holý chybový kód bez časti data – pole sa teda v odpovedi v skutočnosti neobjaví.

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