REST API – WEDOS.protection Domény

GET /domains/{domain}

Vrací informace o jedné doméně připojené k WGP – kombinaci dat z externí administrace WEDOS Global Protection a interní databáze WEDOS.

Parametry:

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

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatný formát parametru
• 2202 – neplatný nebo nepodporovaný formát názvu domény
• 2292 – doména ve WGP pro tento zákaznický účet neexistuje
• 2400 – interní chyba – neregistrovaný návratový kód z WGP API (viz Poznámky)
• 2418 – chybí TXT záznam pro doménu ve stavu Pending_TXT .

Data odpovědi:

• wgp – data domény z externí administrace WGP (např. stav domény, příznak admin účtu a další; položky wedos_client_id a cms jsou z odpovědi odstraněny)
• service – data domény z interní databáze: ID, name, num, user_id, lang, currency, kontaktní údaje fakturační (cli_*) a vlastníka (own_*), status, expiration

Pří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

Vrací stránkovaný seznam šablonových domén dostupných pro danou variantu služby WGP. Použijte jej jako zdroj hodnoty template_domain_id při zřizování domény nebo replikaci nastavení.

Parametry:

• variant_id – povinný, query – ID varianty služby WGP (viz číselník hosting_wedos_protection.variants )
• per_page – volitelný, query – počet záznamů na stránku; výchozí 15, hodnota -1 vrátí všechny záznamy
• page – volitelný, query – číslo stránky; výchozí 1
• locale – volitelný, query – jazyk stránkování, povolené hodnoty cs, en; výchozí en
• search – volitelný, query – hledaný řetězec ve sloupcích custom_name, name

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr (variant_id)
• 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

• data – pole šablonových domén; každá položka obsahuje id, custom_name, name, url
• per_page, total, last_page, from, to – údaje o stránkování
• first_page_url, prev_page_url, next_page_url, last_page_url, path – odkazy na jednotlivé stránky
• links – pole prvků stránkování (url, label, active)

Pří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": "« Previous", "active": false},
      {"url": "https://api.wedos.com/v2/wgp/domains/templates?page=1", "label": "1", "active": true},
      {"url": null, "label": "Next »", "active": false}
    ]
  }
}

POST /domains/info

Vrací informace o jedné nebo více doménách ve WGP (ekvivalent GET /domains/{domain}, ale v těle požadavku můžete zadat několik domén oddělených čárkami).

Parametry:

• domain – povinný – název domény nebo několik názvů oddělených čárkami (např. "domain1.tld,domain2.tld")

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatný formát parametru
• 2202 – neplatný nebo nepodporovaný formát názvu domény
• 2292 – doména ve WGP pro tento zákaznický účet neexistuje
• 2400 – interní chyba – neregistrovaný návratový kód z WGP API
• 2418 – chybí TXT záznam pro doménu ve stavu Pending_TXT .

Data odpovědi: U jedné domény stejná struktura jako u GET /domains/{domain} (klíče wgp a service). U více domén je odpovědí objekt s klíči podle názvů domén, kde každá položka má opět strukturu wgp a service .

Pří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

Zřídí novou doménu ve WGP. Lze jej použít i k obnovení domény, která byla pozastavena (stav disabled), protože její zřízení nebylo po vytvoření včas dokončeno.

Parametry:

• domain – povinný – název domény
• variant_id – povinný, číslo – ID varianty služby (viz číselník hosting_wedos_protection.variants )
• period_id – povinný, číslo – ID periody předplatného
• upstream_ips – volitelný, pole – pole IP adres, které se nebudou překládat na WGP
• template_domain_id – volitelný, číslo – ID šablonové domény použité k nastavení nové domény
• mode – volitelný, řetězec – režim domény, povolené hodnoty ns nebo cname

Návratové kódy:

• 1000 – OK (obnovení dříve pozastavené domény ze stavu disabled )
• 1001 – požadavek přijat, zřízení domény se zpracovává
• 2101 – neplatná hodnota parametru
• 2202 – neplatný nebo nepodporovaný formát názvu domény
• 2203 – neplatná hodnota parametru period_id
• 2272 – neplatný formát IP adresy (upstream_ips)
• 2273 – neplatná hodnota parametru variant_id
• 2276 – nepodporovaná TLD
• 2277 – explicitní www. v názvu domény není povoleno
• 2278 – služba pro tuto doménu již existuje
• 2279 – zálohový účet je zablokován
• 2281 – zálohový účet není aktivní
• 2282 – ze zálohového účtu nelze platit v dané měně
• 2283 – nedostatečný zůstatek na zálohovém účtu
• 2284 – chyba v kontaktních údajích zálohového účtu
• 2285 – nesprávné nastavení fakturace s DPH/bez DPH
• 2291 – doména již ve WGP pro tento zákaznický účet existuje
• 2293 – nelze zjistit zůstatek kreditu na zálohovém účtu
• 2294 – nelze zjistit cenu služby
• 2416 – neplatný režim domény (mode)
• 2417 – neplatný nebo nepodporovaný formát názvu subdomény
• 2422 – nelze určit typ účtu (admin/zákazník)
• 2423 – interní chyba při volání WGP API
• další chybové kódy specifické pro danou operaci (např. validace replikace šablonové domény 2401–2405)

Data odpovědi:

• WGP_ID – ID domény ve WGP
• domain – název domény
• order_num – číslo objednávky (pokud není doména zřízena zdarma nebo admin účtem; také při obnovení ze stavu disabled )
• currency, amount – měna a částka stržená ze zálohového účtu
• acc_amount_before, acc_amount_current – zůstatek zálohového účtu před platbou a po ní
• desc – popis (uveden pouze při obnovení domény ze stavu disabled )

Pří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 zřízení domény, které skončilo chybou (dostupné pouze pro některé stavy domény, např. error_crt).

Parametry:

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

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2292 – doména ve WGP pro tento zákaznický účet neexistuje
• 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

• domain – název domény
• domain_id – ID domény ve WGP
• wedos_client_id – ID klienta ve WGP

Pří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

Smaže nedokončenou objednávku domény – stav, kdy doména uvízla ve WGP bez možnosti dokončit aktivaci a lokální služba ještě neexistuje.

Parametry:

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

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2292 – doména nebyla ve WGP pro tento zákaznický účet nalezena
• 2400 – interní chyba
• 2410 – služba nenalezena
• 2421 – služba WGP již existuje, doména nebude odstraněna

Data odpovědi:

• domain – název domény
• domain_id – ID domény ve WGP
• wedos_client_id – ID klienta ve WGP

Pří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
  }
}