WAPI - WEDOS Protection (WGP) - Dokumentácia a znalostná báza WEDOS

Tento článok sa venuje príkazom WAPI určeným pre službu WEDOS Protection. Informácie o nastavení WAPI a riešení bežných problémov nájdete v článku WAPI – Manuál.

Tento článok obsahuje informácie o nasledujúcich príkazoch:

wgp-domain-create – pridanie domény do WEDOS Protection
wgp-domain-info – výpis informácií o doméne vo WEDOS Protection
wgp-domain-renew – predĺženie služby
wgp-domain-delete – zrušenie služby
wgp-domain-update-subscription – zmena tarifu predplatného
wgp-domain-create-retry – vyriešenie niektorých chýb
wgp-domain-cache-purge – vymazanie cache WP
wgp-domain-template-replicate – replikuje šablónu na existujúcu doménu
wgp-domain-templates-list – zoznam šablónových domén
wgp-services-list – zoznam domén WEDOS Protection

wgp-domain-create

Použite wgp-domain-create požiadavku na vytvorenie záznamu domény vo WEDOS Protection. Táto požiadavka je asynchrónna a komunikuje cez notifikácie &boxbox;.

Parametre

doména = názov domény (povinné)
variant_id = tarif služby (povinné) – 1 = Start, 2 = Advanced, 3 = Expert (tarify a ich ceny nájdete na stránke produktu &boxbox;)
period_id = obdobie služby (povinné) – 1 = mesačne, 4 = ročne
upstream_ips = pole cieľových IP adries (voliteľné) – viac informácií o cieľových IP nájdete v článku Protection – Upstream ciele .
template_domain_id = ID šablónovej domény (voliteľné)
režim = režim domény (voliteľné)
- ns = používa WEDOS NS (predvolené); systém aktivuje doménu iba vtedy, ak úspešne overí, že používa WEDOS DNS.
- cname = umožňuje použiť DNS servery iného poskytovateľa alebo pridať subdomény cez CNAME záznam; režim pre každú doménu 3. a vyššej úrovne je vždy cname.

Viac informácií o pridaní domény do WEDOS Protection nájdete v článku Protection – Pridanie novej domény .

Predvolený režim pre domény 2. úrovne je ns. Predvolený a jediný dostupný režim pre domény 3. a vyššej úrovne (subdomény) je cname.

Návratové hodnoty

1000 = OK
1001 = Požiadavka čaká na spracovanie
2101 = Nesúlad parametrov
2202 = Neplatný alebo nepodporovaný formát názvu domény
2203 = Neplatné period_id
2206 = Neplatná požiadavka – interná chyba
2272 = Neplatný formát IP adresy
2273 = Neplatný variant
2274 = Interná chyba – chýba parameter user_id
2275 = Interná chyba – používateľ nebol nájdený
2276 = Nepodporovaná TLD alebo prekročená maximálna úroveň domény
2277 = Nie je povolené explicitne uvádzať www. pred názvom domény
2278 = Názov domény nie je možné použiť – s týmto názvom domény už existuje služba
2279 = Kreditný účet je zablokovaný
2280 = Kreditný účet je aktívny
2281 = Neaktívny kreditný účet
2282 = Neplatná mena kreditného účtu
2283 = Neplatná suma alebo nedostatočný kredit
2284 = Chyba informácií o kreditnom účte
2285 = Nesprávne nastavenie DPH
2286 = Kreditný účet – interná chyba
2290 = Kreditný účet – pohyb nebol pridaný na kreditný účet
2291 = Doména už v tomto zákazníckom účte v API WGP existuje
2293 = Nie je možné zistiť zostatok na kreditnom účte
2294 = Nie je možné zistiť cenu služby
2295 = Doménu nie je možné vytvoriť vo WGP. Platba bola zrušená.
2296 = Pohyb na kreditnom účte nie je možné zrušiť
2400 = Interná chyba WGP
2401 = Šablónu nie je možné použiť na doménu
2402 = Neplatná šablónová doména
2403 = Nesúlad šablónovej domény a používateľa
2404 = Nesúlad šablónovej domény a tarifu domény
2405 = Dosiahnutý denný limit šablónových domén
2416 = Neplatný režim domény

Dáta odpovede

WGP_ID = ID záznamu domény vo WGP
doména = názov domény
order_num = číslo objednávky
mena = mena kreditného účtu
suma = cena služby
acc_amount_before = zostatok kreditného účtu pred aktiváciou služby
acc_amount_current = zostatok kreditného účtu po aktivácii služby

Dáta odpovede notifikácie

WGP_ID = ID záznamu domény vo WGP
doména = názov domény
order_num = číslo objednávky

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-create",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld",
      "variant_id": "1 = Start, 2 = Advanced, 3 = Expert",
      "period_id": "1 = monthly billing, 4 = yearly billing",
      "upstream_ips": ["IP address 1", "IP address 2", "(optional)"],
      "template_domain_id": "ID of the template domain (optional)",
      "mode": "domain mode (optional)"
    }
  }
}

JSON odpoveď (požiadavka čaká na spracovanie):

{
  "response": {
    "code": 1001,
    "result": "Request pending",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-create",
    "data": {
      "WGP_ID": "assigned domain ID in WG",
      "domain": "domain_name.tld",
      "order_num": "order number",
      "currency": "currency code",
      "amount": "price",
      "acc_amount_before": "credit account balance before transaction",
      "acc_amount_current": "credit account balance after transaction"
    }
  } 
}

JSON notifikácia po dokončení nastavenia:

{
  "notify": {
    "code": "1000",
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-create",
    "id": "POLL queue ID",
    "data": {
      "WGP_ID": "assigned domain ID in WG",
      "domain": "domain_name.tld",
      "order_num": "order number",
    }
  }
}

wgp-domain-info

Použite wgp-domain-info požiadavku na zobrazenie informácií o stave domény v službe WEDOS Protection.

Parametre

doména = názov domény (povinné)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2101 = Nesúlad parametrov
2202 = Neplatný alebo nepodporovaný formát názvu domény
2206 = Neplatná požiadavka – interná chyba
2292 = Doména nebola v tomto zákazníckom účte v API WGP nájdená

Dáta odpovede

wgp = stav domény vo WEDOS Protection; parameter state nadobúda jednu z nasledujúcich hodnôt, pričom niektoré môžu obsahovať odlišné dáta:
- pending_dns = prebieha zisťovanie DNS záznamov domény
- spracovanie = čaká sa na nastavenie služby
- zaseknuté = čaká sa na softvérové požiadavky
- pending_txt = čaká sa na overenie TXT záznamu (čiastočná šablóna)
- pending_ns = čaká sa na nastavenie nameserverov (čiastočná šablóna pre režim NS a režim CNAME)
- pending_dns_refresh = opakované zisťovanie DNS, ak predchádzajúci pending_dns nenašiel žiadne DNS záznamy
- pending_crt = čaká sa na certifikát Let’s Encrypt pre WG
- aktívna = doména je aktívna (úplná šablóna)
služba = stav domény v systéme WEDOS

Podrobnejšie informácie o návratových dátach nájdete v šablóne.

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-info",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

JSON odpoveď (OK, stav aktívna):

{
  "response": {
    "code": 1000,
    "result": "ok",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-info",
    "data": {
    "wgp":{
        "domain": "domain_name.tld",
        "domain_id": "assigned domain ID",
        "domain_tld": "tld",
        "modes": ["režim domény"],
        "settings": {
          "cache": "cache status (empty off, 1 on)"
        },
        "url": "https://client.wedos.global/protection/domains/domain_name.tld",
        "state": "active",
        "state_data": {
          "dns_ip_addresses": ["WG proxy IPv4 address", "WG proxy IPv6 address"],
          "dns_pointing_to_proxy": "DNS proxy routing check, empty false, 1 true",
          "dns_records_new": [
            {
              "name": "",
              "data": "WG proxy IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "WG proxy IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "",
              "data": "WG proxy IPv6 address",
              "type": "AAAA",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "WG proxy IPv6 address",
              "type": "AAAA",
              "ttl": 300
            }
          ],
          "dns_records": [
            {
              "name": "",
              "data": "current IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "current IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "",
              "data": "current IPv6 address",
              "type": "AAAA",
              "ttl": 300
            },
            {
              "name": "",
              "data": "current IPv6 address",
              "type": "AAAA",
              "ttl": 300
            }
          ]
        }
      },
      "service": {
        "ID": "service ID in the system",
        "name": "domain_name.tld",
        "num": "order number",
        "user_id": "user ID in the system",
        "lang": "language code",
        "currency": "currency code",
        "cli_legal_type": "Billing - 1 = natural person, 2 = enterpreneur, 3 = legal person",
        "cli_company" :"Billing – Company name",
        "cli_fname": "Billing – Name",
        "cli_lname": "Billing – Surname",
        "cli_email": "Billing – Email",
        "cli_email2": "Billing – Backup email",
        "cli_phone": "Billing – Phone",
        "cli_mobile": "Billing – Mobile",
        "cli_fax": "Billing – Fax",
        "cli_ic": "Billing – Company ID",
        "cli_dic": "Billing – VAT ID",
        "cli_taxpayer": "Billing – VAT payer (0/1)",
        "cli_addr_street": "Billing – Street and number",
        "cli_addr_city": "Billing – Town",
        "cli_addr_zip": "Billing – ZIP",
        "cli_addr_country": "Billing – Country code",
        "cli_name_vies": "Billing – VIES name",
        "own_legal_type": "Operator - 1 = natural person, 2 = enterpreneur, 3 = legal person",
        "own_company": "Operator – Company name",
        "own_fname": "Operator - Name",
        "own_lname": "Operator - Surname",
        "own_email": "Operator - Email",
        "own_phone": "Operator - Phone",
        "own_ic": "Operator - Company ID",
        "own_dic": "Operator - VAT ID",
        "own_addr_street": "Operator – Street and number",
        "own_addr_city": "Operator - Town",
        "own_addr_zip": "Operator - ZIP",
        "own_addr_country": "Operator – Country code",
        "status": "service status in WEDOS customer administration",
        "expiration": "expiration date YYYY-MM-DD"
      }
    }
  }
}

JSON dáta (OK, stav pending_txt):

{
    ...
    "data": {
        ...
        "state": "pending_txt",
        "state_data": {
            "name": "_TXT_record_name",
            "name_formatted": "_TXT_record_name_with_domain.tld",
            "value": "TXT-record-value--verification-code"
        }
    }
}

JSON dáta (OK, stav pending_ns v ns režime):

{
    ...
    "data": {
        ...
        "state": "pending_ns",
        "state_data": {
            "assigned": [ 
                "assigned-nameserver.ns.wedos.net",
                "assigned-nameserver.ns.wedos.com",
                "assigned-nameserver.ns.wedos.eu",
                "assigned-nameserver.ns.wedos.cz"
            ],
            "assigned_own": [ 
                [
                    "own-ns1.if-permitted.tld",
                    "own-ns2.if-permitted.tld"
                ]
            ],
            "resolved": [ 
                "current-resolved-ns1.domain.tld",
                "current-resolved-ns2.domain.tld"
            ],
            "resolved_at": "UTF timestamp of last performed DNS check",
            "next_resolve_at": "UTF timestamp of next scheduled DNS check"
        }
    }
}

JSON dáta (OK, stav pending_ns v cname režime; crt_name a cname sú názvy a hodnoty záznamov, ktoré si používateľ nastaví u svojho poskytovateľa DNS):

{
    ...
    "state_data": {
            "crt_cname": [
                {
                    "name": "_acme-challenge",
                    "value": "_acme-challenge.verification_code.wgp123.wedos.global"
                }
            ],
            "cname": [
                {
                    "name": "*",
                    "value": "verification_code.wgp123.wedos.global"
                },
                {
                    "name": "www",
                    "value": "verification_code.wgp123.wedos.global"
                }
            ],
            "resolved_at": "UTF timestamp of last performed DNS check",
            "next_resolve_at": "UTF timestamp of next scheduled DNS check"
        }

    }
}

wgp-domain-renew

Použite wgp-domain-renew požiadavku na predĺženie domény v službe WEDOS Protection o ďalšie obdobie.

Parametre

service_id = ID služby (povinné)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2101 = Nesúlad parametrov
2152 = Predĺženie služby je zablokované
2206 = Chýba user_id
2279 = Zablokovaný kreditný účet
2281 = Neaktívny kreditný účet
2282 = Neplatná mena kreditného účtu
2283 = Neplatná suma alebo nedostatočný kredit
2284 = Chyba informácií o kreditnom účte
2286 = Kreditný účet – interná chyba
2293 = Nie je možné zistiť zostatok na kreditnom účte
2406 = Doména/služba nebola nájdená
2409 = Predĺženie služby zlyhalo

Dáta odpovede

service_id = ID služby
name = Názov domény
date_from = Dátum platnosti služby
date_to = Dátum expirácie služby
fakt_order_num = Číslo objednávky pre predĺženie služby
mena = Mena kreditného účtu
price = Cena predĺženia
kredit = Zostatok kreditného účtu po predĺžení

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-renew",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID"
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-renew",
    "data": {
      "service_id":"service ID",
      "domain":"domain_name.tld",
      "date_from":"YYYY-MM-DD",
      "date_to":"YYYY-MM-DD",
      "fakt_order_num":"Order nr.",
      "currency":"Currency code",
      "price": Amount,
      "credit":"Credit account balance"
    }
  }
}

wgp-domain-delete

Použite wgp-domain-delete príkaz na odstránenie domény zo služby WEDOS Protection.

Parametre

service_id = ID služby (povinné)
force = Vynútené odstránenie bez ohľadu na A/AAAA záznamy domény (voliteľné, ak existuje token na prepis DNS záznamov)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2274 = Interná chyba – chýba parameter user_id
2292 = Doména nebola v tomto používateľskom účte nájdená
2400 = Interná chyba
2410 = Služba nebola nájdená
2411 = Nedostupný token na prepis DNS
2412 = Zlyhala API požiadavka na prepis DNS
2413 = Požiadavka zlyhala, WGP nemá oprávnenie aktualizovať DNS
2414 = WGP nemá token a používateľ nenastavil príznak force vo WAPI

Dáta odpovede

doména = názov domény
domain_id = ID domény
wedos_client_id = ID klienta
service_id = ID služby
service_type = typ služby
wdns_data = pole aktualizácií IP

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "force": true (forces delete without updating DNS) | false (restores original DNS if able)
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": id,
      "wedos_client_id":"id",
      "service_id":id,
      "service_type":"hosting_wedos_protection",
      "wdns_data":{
        "domain":"domain_name.tld",
        "rows_a":{
          "rem":{
            "removed A record ID":{
              "name":"removed A record name",
              "ttl":"removed A record TTL",
              "rdtype":"A",
              "rdata":"removed A record IP"
            }
          },
          "add":{
            "added A record ID":{
              "name":"added A record name",
              "ttl":"added A record TTL",
              "rdtype":"A",
              "rdata":"added A record IP"
            }
          },
          "stay":[ "list of unchanged addresses" ]
        },
      "rows_aaaa":
        "rem":{
            "removed AAAA record ID":{
              "name":"removed AAAA record name",
              "ttl":"removed AAAA record TTL",
              "rdtype":"AAAA",
              "rdata":"removed AAAA record IP"
            }
          },
          "add":{
            "added AAAA record ID":{
              "name":"added AAAA record name",
              "ttl":"added AAAA record TTL",
              "rdtype":"AAAA",
              "rdata":"added AAAA record IP"
            }
          },
          "stay":[ "list of unchanged addresses" ]
        }
      }
    }
  }
}

wgp-domain-delete-order

Použite wgp-domain-delete príkaz na odstránenie objednávky domény zo služby WEDOS Protection. Hodí sa na odstránenie služieb, ktoré zlyhali pri vytváraní.

Táto požiadavka neodstráni existujúce služby. Na tie použite wgp-domain-delete.

Parametre

doména = názov domény (povinné)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2274 = Interná chyba – chýba parameter user_id
2292 = Doména nebola v tomto používateľskom účte nájdená
2400 = Interná chyba
2410 = Služba nebola nájdená
2421 = Služba WGP existuje, doména nebude odstránená

Dáta odpovede

doména = názov domény
domain_id = ID domény
wedos_client_id = ID klienta

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete-order",
    "clTRID": "your ID",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete-order",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": id,
      "wedos_client_id":"id"WGP service exists, the domain will not be deleted
    }
  }
}

JSON odpoveď (Chyba – služba WEDOS Protection už existuje):

{
  "response": {
    "code": 2421,
    "result": "WGP service exists, the domain will not be deleted",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete-order"
  }
}

wgp-domain-update-subscription

Použite wgp-domain-update-subscription požiadavku na zmenu tarifu alebo fakturačného obdobia služby WEDOS Protection.

Parametre

service_id = ID služby (povinné)
new_variant_id = tarif služby (povinné) – 1 = Start, 2 = Advanced, 3 = Expert
new_period_id = fakturačné obdobie (povinné) – 1 = mesačne, 4 = ročne

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2101 = Nesúlad parametrov
2203 = Neplatné period_id
2273 = Neplatný variant
2293 = nie je možné zistiť hodnotu kreditu
2294 = nie je možné zistiť cenu služby
2279 = kreditný účet je zablokovaný
2281 = neaktívny kreditný účet
2282 = nie je možné platiť v mene kreditu
2283 = neplatná suma alebo nedostatočný zostatok kreditu
2284 = neplatné kontaktné údaje kreditného účtu
2285 = neplatná fakturácia DPH
2286 = kreditný účet – neznámy návratový kód
2400 = Interná chyba WGP
2406 = Doména/služba nebola nájdená
2408 = Chýba variant_id alebo period_id

Dáta odpovede

doména = názov domény
domain_id = ID domény
wedos_client_id = ID klienta
service_id = ID služby
service_type = typ služby
variant_id = ID tarifu služby
period_id = ID fakturačného obdobia
dirty = príznak aktualizácie (0 = bez zmeny, 1 = zmenené)

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-update-subscription",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "new_variant_id": "1, 2, or 3",
      "new_period_id": "1, or 4"
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-update-subscription",
    "data":{
      "domain": "domain_name.tld",
      "domain_id": domain ID,
      "wedos_client_id": "customer ID",
      "service_id": service ID,
      "service_type": "service type ID",
      "variant_id": plan ID,
      "period_id": billing period ID,
      "dirty": 0|1
    }
  }
}

wgp-domain-create-retry

Pomocou wgp-domain-create-retry príkazu zopakujete požiadavku o vydanie certifikátu. Môžete ho použiť na vyriešenie stavu error_crt vráteného príkazom wgp-domain-info .

Parametre

doména = názov domény (povinné)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2292 = Doména nebola v tomto používateľskom účte nájdená
2400 = Interná chyba
4000 = Interná chyba

Dáta odpovede

doména = Názov domény
domain_id = ID domény vo WGP
wedos_client_id = ID klienta

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-create-retry",
    "clTRID": "your ID",
    "data": {
      "domain": "nazev_domeny.tld"
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-create-retry",
    "data":{
      "domain": "domain_name.tld",
      "domain_id": domain ID,
      "wedos_client_id": "customer ID"
    }
  }
}

wgp-domain-cache-purge

Použite wgp-domain-cache-purge na vymazanie cache domény WEDOS Protection.

Parametre

service_id = ID služby (povinné)
service_type = Typ služby (voliteľné)
- hodnoty: hosting_wedos_protection (predvolené), hosting_domain
limiter_decay = Doba blokovania v sekundách (voliteľné)
- predvolená hodnota 5
limiter_reset = Zrušenie limitera (voliteľné)
- 0 (nie, predvolené), 1 (áno)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2101 = Nesúlad parametrov
2274 = interná chyba – chýba user_id
2400 = interná chyba – neznámy návratový kód
2406 = doména/služba nebola nájdená
2415 = dosiahnutá hodnota limitera
4000 = systémová chyba

Dáta odpovede

doména = Názov domény
domain_id = ID domény
domain_tld = TLD domény
service_id = ID služby
wedos_client_id = ID klienta
limiter_available_in = Čas v sekundách, kým bude funkcia opäť dostupná

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-cache-purge",
    "clTRID": "own ID code",
    "data": {
      "service_id": Service ID,
      "service_type": "service type code (optional)",
      "limiter_decay": limiter timeout (in seconds, optional),
      "limiter_reset": 0|1 (optional)
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-cache-purge",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": domain ID,
      "domain_tld":"tld",
      "wedos_client_id":"customer account ID"
    }
  }
}

wgp-domain-template-replicate

Použite wgp-domain-template-replicate požiadavku na zmenu nastavení cieľovej domény podľa zvolenej šablónovej domény.

Šablónu vytvoríte podľa návodu v článku Protection – Šablóny. Šablóny momentálne nie je možné vytvárať cez WAPI.

Parametre

service_id – ID služby (povinné)
template_domain_id – ID cieľovej šablónovej domény (povinné)
service_type – typ služby (voliteľné)
- hodnoty: hosting_domain, hosting_wedos_protection

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2101 = Nesúlad parametrov
2400 = Interná chyba WGP
2401 = Šablónu nie je možné použiť na doménu
2402 = Neplatná šablónová doména
2403 = Nesúlad šablónovej domény a používateľa
2404 = Nesúlad šablónovej domény a tarifu domény
2405 = Dosiahnutý denný limit šablónových domén
2406 = Doména/služba nebola nájdená
2407 = Šablónová doména nebola nájdená
4000 = Interná chyba

Dáta odpovede

doména = názov domény
domain_id = ID domény
service_id = ID služby
service_type = typ služby
template_domain_id = ID šablónovej domény
replications_count = počet vykonaných replikácií
replications_limit = maximálny počet replikácií

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-template-replicate",
    "clTRID": "your ID",
    "data": {
      "service_id": service ID,
      "template_domain_id": template domain ID,
      "service_type": "hosting_domain, or hosting_wedos_protection (optional)"
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-template-replicate",
    "data":{
      "domain":"domain_namey.tld",
      "domain_id": domain ID,
      "service_id": service ID,
      "service_type": "service type",
      "template_domain_id": template domain ID,
      "replications_count": replication count,
      "replications_limit": replication limit
    }
  }
}

wgp-domain-templates-list

Použite wgp-domain-templates-list požiadavku na získanie zoznamu šablónových domén pre zvolený tarif WEDOS Protection.

Šablónu vytvoríte podľa návodu v článku Protection – Šablóny. Šablóny momentálne nie je možné vytvárať cez WAPI.

Parametre

variant_id = ID tarifu (povinné)
per_page = Počet záznamov na stránku (predvolené = 15, všetky záznamy = -1) (voliteľné)
stránka = Číslo stránky (predvolené = 1) (voliteľné)
locale = Jazyk (predvolené = en, podporované = cs, en) (voliteľné)
search = Vyhľadávanie v stĺpcoch custom_name, name (voliteľné)

Návratové hodnoty

1000 = OK
2100 = Chýba povinný parameter
2400 = interná chyba
4000 = interná chyba

Dáta odpovede

dáta = Zoznam šablónových domén
- id = ID šablónovej domény
- custom_name = Názov šablónovej domény (nastavený používateľom)
- name = Názov šablónovej domény (systémový)
- url = URL šablónovej domény
first_page_url = URL prvej stránky zoznamu
z = Začiatok stránkovania
last_page = Číslo poslednej stránky
last_page_url = URL poslednej stránky zoznamu
odkazy = Pole odkazov stránkovania
- url = URL odkazu
- označenie = Popis tlačidla
- aktívna = null|1
next_page_url = URL ďalšej stránky
path = URL zoznamu šablónových domén
per_page = Počet položiek na stránku
prev_page_url = URL predchádzajúcej stránky
na = Koniec stránkovania
celkom = Celkový počet stránok

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-templates-list",
    "clTRID": "your ID",
    "data": {
      "variant_id": plan ID 1 = Start, 2 = Advanced, 3 = Expert,
      "per_page": entries per page (optional),
      "page": page nr. (optional),
      "locale": "cs, or en (optional)",
      "search": "Search by custom_name, name (optional)"
    }
  }
}

JSON odpoveď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-templates-list",
    "data":{
      [
        {
          "id": Template domain ID,
          "custom_name":"termplate domain user name",
          "name":"system-name.template",
          "url":"https://template.domain.url/system-name.template"
        }
      ],
      "first_page_url":"https://first.page.url",
      "from": 1st page number,
      "last_page": last page number,
      "last_page_url":"https://last.page.url",
      "links":[
        {
          "url": "https://page.url",
          "label":"Button label",
          "active": null|1
        }
      ],
      "next_page_url": "https://next.page.url",
      "path":"https://list.url",
      "per_page": entries per page,
      "prev_page_url":"https://previous.page.url",
      "to": last list item,
      "total": total page count
    }
  }
}

wgp-services-list

Pomocou wgp-services-list požiadavky môžete získať zoznam domén so službou WEDOS Protection. Filtrovať môžete podľa stavu.

Požiadavka wgp-services-list uvádza iba domény, ktoré boli pridané ako služby. Pri doménach pridaných v režime B2B sa tak stane až po úplnom nastavení domény. Dovtedy môžete použiť wgp-domain-info príkaz na kontrolu stavu tejto domény.

Parametre

status = stav služby (voliteľné)

Návratové hodnoty

1000 = OK
2206 = Neplatná požiadavka – interná chyba

Dáta odpovede

ID = ID záznamu domény
name = názov domény
status = stav služby
expirácia = Dátum expirácie služby WG

Šablóny

JSON požiadavka

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-services-list",
    "clTRID": "own ID code",
    "data": {
      "status": "active, expired, disabled or deleted"
    }
  }
}

JSON odpoveď (OK)

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command":"wgp-services-list",
    "data":{
      "service ID in the system":{
        "ID":"service ID in the system",
        "domain":"domain_name.tld",
        "status":"service status",
        "expiration": "expiration date YYYY-MM-DD"
    }
  }
}

Bolo to užitočné?

Ďakujeme za spätnú väzbu!

WAPI – WEDOS Protection (WGP)

wgp-domain-create

Parametre

Návratové hodnoty

Dáta odpovede

Dáta odpovede notifikácie

Šablóny

wgp-domain-info

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-renew

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-delete

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-delete-order

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-update-subscription

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-create-retry

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-cache-purge

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-template-replicate

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-domain-templates-list

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

wgp-services-list

Parametre

Návratové hodnoty

Dáta odpovede

Šablóny

Bolo to užitočné?

Obsah článku

Prehliadať kategórie