Tento článek obsahuje WAPI příkazy pro WEDOS Global. Hledáte-li návody na správu služeb Global v administraci nebo WordPress pluginu, hledejte v kategorii WEDOS Global.
Pokud jste WAPI ještě nepoužívali, projděte si nejprve článek WAPI v kostce (manuál).
V tomto článku najdete informace k následujícím příkazům:
- wgp-domain-create – přidání domény do systému WEDOS Global
- wgp-domain-info – výpis informací o doméně
- wgp-domain-renew – prodloužení služby
- wgp-domain-delete – ukončení služby
- wgp-domain-update-subscription – změna předplatného
- wgp-domain-retry – řeší některé chybové stavy
- wgp-domain-cache-purge – promazává WGP cache
- wgp-domain-template-replicate – replikuje šablonu na existující doménu
- wgp-domain-templates-list – seznam šablonovacích domén
- wgp-services-list – seznam domén v systému WEDOS Global
wgp-domain-create
Příkazem wgp-domain-create vytvoříte záznam domény ve službě WEDOS Global. Tento příkaz je asynchronní a komunikuje prostřednictvím notifikací.
Parametry
- domain = název domény (povinný)
- variant_id = varianta služby (povinný) – 1 = Start, 2 = Advanced, 3 = Expert (přehled tarifů a ceník najdete na produktovém webu)
- period_id = perioda (povinný) – 1 = měsíční, 4 = roční
- upstream_ips = pole cílových IP adres (nepovinný) – více informací o cílových IP najdete v článku Global – DNS a cílové IP adresy
- template_domain_id = ID šablonovací domény (nepovinný)
- mode = režim domény (nepovinný)
- ns = použije NS WEDOS (výchozí hodnota); aktivace služby neproběhne, dokud systém neověří, že doména používá DNS servery WEDOS.
- cname = umožňuje použít DNS servery jiného poskytovatele, nebo přidání subdomény prostřednictvím záznamu CNAME; pro domény 3. a vyššího řádu je vždy hodnota cname.
Více informací o přidání domény do systému najdete v článku Global – Přidání domény.
Návratové hodnoty
- 1000 = OK
- 1001 = požadavek se vyřizuje
- 2101 = hodnota parametru není správná
- 2202 = chybný nebo nepodporovaný formát jména domény
- 2203 = hodnota parametru period_id není správná
- 2206 = interní chyba
- 2272 = chybný formát IP adresy
- 2273 = hodnota parametru variant_id není správná
- 2274 = interní chyba – parametr user_id chybí
- 2275 = interní chyba – uživatel user_id nebyl nalezen
- 2276 = nepodporované TLD nebo maximální úroveň domény překročena
- 2277 = není povolena předpona www. ve jménu domény
- 2278 = služby pro doménu již existuje
- 2279 = zálohový účet je uzamčen
- 2280 = zálohový účet je aktivní
- 2281 = zálohový účet není aktivní
- 2282 = není možné platit ze zálohového účtu v zadané měně
- 2283 = nedostatečný zůstatek na zálohovém účtu nebo špatně zadaná částka
- 2284 = chyba v kontaktních údajích na zálohovém účtu
- 2285 = nesprávné nastavení fakturace s/bez DPH
- 2286 = zálohový účet – interní chyba
- 2290 = pohyb na zálohový účet nebyl přidán
- 2291 = doména již pro příslušný zákaznický účet ve WGP API existuje
- 2293 = nelze získat stav kreditu na zálohovém účtu
- 2294 = nelze získat cenu služby
- 2295 = interní chyba – nelze vytvořit doménu ve WGP
- 2296 = pohyb na zálohový účet nelze stornovat
- 2400 = interní chyba ve WGP
- 2401 = neplatná doména pro replikaci
- 2402 = neplatná šablonovací doména
- 2403 = nesrovnalost uživatele mezi doménou a šablonovací doménou
- 2404 = nesrovnalost plánu předplatného mezi doménou a šablonovací doménou
- 2405 = byl dosažen denní limit změn šablonovací domény
- 2416 = neplatný režim domény
Návratová data
- WGP_ID = ID záznamu domény ve WGP
- domain = název domény
- order_num = číslo objednávky
- currency = měna pohybu na zálohovém účtu
- amount = cena služby
- acc_amount_before = stav zálohového účtu před aktivací služby
- acc_amount_current = stav zálohového účtu po aktivaci služby
Návratová data notifikace
- WGP_ID = ID záznamu domény ve WGP
- domain = název domény
- order_num = číslo objednávky
Šablony
wgp-domain-create JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-create",
"clTRID": "vlastní id kód",
"data": {
"domain": "nazev_domeny.tld",
"variant_id": 1 = Start, 2 = Advanced, 3 = Expert,
"period_id": 1 = měsíční fakturace, 4 = roční,
"upstream_ips": ["IP adresa 1", "IP adresa 2", "(nepovinné)"],
"template_domain_id": "ID šablonovací domény",
"mode": "režim domény (nepovinný)"
}
}
}
JSON odpověď (požadavek se vyřizuje)
{
"response": {
"code": 1001,
"result": "Request pending",
"timestamp": UTF čas,
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-create",
"data": {
"WGP_ID": přidělené číselné ID domény v systému,
"domain": "nazev_domeny.tld",
"order_num": "číslo objednávky",
"currency": "kód měny",
"amount": "cena",
"acc_amount_before": "stav zálohového účtu před transakcí",
"acc_amount_current": "stav zálohového účtu po transakci"
}
}
}
JSON notifikace o úspěšném dokončení
{
"notify": {
"code": 1000,
"result": "OK",
"timestamp": UTF čas,
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-create",
"id": "id pro POLL frontu",
"data": {
"WGP_ID": přidělené číselné ID domény v systému,
"domain": "nazev_domeny.tld",
"order_num": "číslo objednávky",
}
}
}
wgp-domain-info
Příkazem wgp-domain-info vypíšete informace o stavu jedníé nebo více domén ve službě WEDOS Global.
Parametry
- domain = název domény nebo více domén oddělených čárkami (povinný)
Návratové hodnoty
- 1000 = OK
- 2100 = chybí povinný parametr
- 2101 = chybný tvar parametrů
- 2202 = chybný nebo nepodporovaný formát jména domény
- 2206 = chybí user_id
- 2292 = doména pro příslušný zákaznický účet ve WG API neexistuje
Návratová data
- wgp = stav domény v systému WG; hodnota state může nabývat těchto hodnot:
- pending_dns = probíhá resolvování DNS záznamů domény
- processing = čeká se na nastavení služby
- stuck = čeká se na softwarové požadavky
- pending_txt = čeká se na ověření TXT záznamem v DNS
- pending_ns = čeká se na nastavení nameserverů
- pending_dns_refresh = opětovné resolvování DNS záznamů u domény, pokud po stavu pending_dns nebyly nalezeny žádné DNS záznamy
- pending_crt = čeká se na vytvoření LetsEncrypt certifikátu ze strany WG
- error_crt = doména byla dlouho ve stavu pending_crt. Použijte příkaz wgp-domain-retry.
- active = doména je aktivní
- service = stav domény v administraci WEDOS
Podrobnější informace k návratovým datům najdete v šabloně.
Šablony
wgp-domain-info JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-info",
"clTRID": "vlastní id kód",
"data": {
"domain": "nazev_domeny.tld",
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": UTF čas,
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-info",
"data": {
"wgp":{
"domain": "nazev_domeny.tld",
"domain_id": "přidělené číselné ID domény v systému",
"domain_tld": "tld",
"settings": {
"cache": "stav cache (prázdný vypnuto, 1 zapnuto)"
},
"url": "https:\/\/client.wedos.global\/protection\/domains\/nazev_domeny.tld",
"state": "stav služby",
"state_data": {
"dns_ip_addresses": ["IPv4 adresa WG proxy", "IPv6 adresa WG proxy"],
"dns_pointing_to_proxy": "ověření nasměrování DNS na proxy, prázdný nesměruje, 1 ok",
"dns_records_new": [
{
"name": "",
"data": "IPv4 adresa WG proxy",
"type": "A",
"ttl": 300
},
{
"name": "*",
"data": "IPv4 adresa WG proxy",
"type": "A",
"ttl": 300
},
{
"name": "",
"data": "IPv6 adresa WG proxy",
"type": "AAAA",
"ttl": 300
},
{
"name": "*",
"data": "IPv6 adresa WG proxy",
"type": "AAAA",
"ttl": 300
}
],
"dns_records": [
{
"name": "",
"data": "Zjištěná aktuální IPv4",
"type": "A",
"ttl": 300
},
{
"name": "*",
"data": "Zjištěná aktuální IPv4",
"type": "A",
"ttl": 300
},
{
"name": "",
"data": "Zjištěná aktuální IPv6",
"type": "AAAA",
"ttl": 300
},
{
"name": "",
"data": "Zjištěná aktuální IPv6",
"type": "AAAA",
"ttl": 300
}
]
}
},
"service": {
"ID": "číselné ID služby v systému",
"name": "nazev_domeny.tld",
"num": "číslo objednávky",
"user_id": "číselné ID uživatele v systému",
"lang": "kód jazyka",
"currency": "kód měny",
"cli_legal_type": "Fakturace - 1 = fyzická osoba, 2 = podnikatel, 3 = právnická osoba",
"cli_company" :"Fakturace – Název firmy",
"cli_fname": "Fakturace – Jméno",
"cli_lname": "Fakturace – Příjmení",
"cli_email": "Fakturace – Email",
"cli_email2": "Fakturace – Záložní email",
"cli_phone": "Fakturace – Telefon",
"cli_mobile": "Fakturace – Mobil",
"cli_fax": "Fakturace – Fax",
"cli_ic": "Fakturace – IČO",
"cli_dic": "Fakturace – DIČ",
"cli_taxpayer": "Fakturace – plátce DPH (0/1)",
"cli_addr_street": "Fakturace – Ulice a ČP",
"cli_addr_city": "Fakturace – Město",
"cli_addr_zip": "Fakturace – PSČ",
"cli_addr_country": "Fakturace – Kód země",
"cli_name_vies": "Fakturace – Jméno v VIES",
"own_legal_type": "Provozovatel - 1 = fyzická osoba, 2 = podnikatel, 3 = právnická osoba",
"own_company":"Provozovatel – Název firmy",
"own_fname":"Provozovatel - Jméno",
"own_lname":"Provozovatel - Příjmení",
"own_email":"Provozovatel - Email",
"own_phone":"Provozovatel - Telefon",
"own_ic":"Provozovatel - IČO",
"own_dic":"Provozovatel - DIČ",
"own_addr_street":"Provozovatel – Ulice a ČP",
"own_addr_city":"Provozovatel - Město",
"own_addr_zip":"Provozovatel - PSČ",
"own_addr_country":"Provozovatel – Kód země",
"status":"stav služby v administraci WEDOS",
"expiration":"datum expirace YYYY-MM-DD"
}
}
}
}
wgp-domain-renew
Příkazem wgp-domain-renew prodloužíte doménu ve službě WEDOS Global na další období.
Parametry
- service_id = ID služby (povinný)
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2101 = hodnota parametru není správná
- 2152 = obnovení služby zakázáno
- 2206 = chybí user_id
- 2279 = zálohový účet je uzamčen
- 2281 = zálohový účet není aktivní
- 2282 = není možné platit ze zálohového účtu v zadané měně
- 2283 = nedostatečný zůstatek na zálohovém účtu nebo špatně zadaná částka
- 2284 = chyba v kontaktních údajích na zálohovém účtu
- 2286 = zálohový účet – interní chyba – neevidovaný návratový kód
- 2293 = nelze získat stav kreditu na zálohovém účtu
- 2406 = doména/služba nebyla nalezena
- 2409 = prodloužení služby se nezdařilo
Návratová data
- service_id = ID služby
- name = Název domény
- date_from = Datum platnosti služby
- date_to = Datum expirace služby
- fakt_order_num = Číslo objednávky pro prodloužení slžby
- currency = Měna, ve které je veden zálohový účet
- price = Částka za prodloužení odbobí
- credit = Stav zálohového účtu po provedení prodloužení odbobí
Šablony
wgp-domain-renew JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-renew",
"clTRID": "vlastní id kód",
"data": {
"service_id": "ID služby"
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-renew",
"data": {
"service_id":"ID služby",
"domain":"nazev_domeny.tld",
"date_from":"YYYY-MM-DD",
"date_to":"YYYY-MM-DD",
"fakt_order_num":"Číslo objednávky",
"currency":"Kód měny",
"price": Částka,
"credit":"Stav zálohového účtu po prodloužení"
}
}
}
wgp-domain-delete
Příkazem wgp-domain-delete smažete doménu ze služby WEDOS Global.
Parametry
- service_id = ID služby (povinný)
- force = Vynucení smazání služby bez ohledu na změnu A/AAAA domény (nepovinné, pokud existuje token pro přepis DNS záznamů)
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2274 = interní chyba – parametr user_id chybí
- 2292 = doména pro tento zákaznický účet nebyla ve WGP nalezena
- 2400 = interní chyba
- 2410 = služba nebyla nalezena
- 2411 = není dostupný token pro přepis DNS
- 2412 = API request pro přepis DNS se nezdařil
- 2413 = příkaz nelze provézt, WGP nemá oprávnění pro manipulaci s DNS domény
- 2414 = WGP nemá token a uživatel nedal ve WAPI příznak force
Návratová data
- domain = název domény
- domain_id = ID domény
- wedos_client_id = ID zákazníka
- service_id = ID služby
- service_type = typ služby
- wdns_data = pole změn IP adres
wgp-domain-delete JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-delete",
"clTRID": "vlastní id kód",
"data": {
"service_id": "ID služby",
"force": true (vynutí smazání služby bez změny DNS) | false (pokud může, odebere záznamy WG a nasměruje doménu)
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-delete",
"data":{
"domain":"nazev_domeny.tld",
"domain_id":id,
"wedos_client_id":"id",
"service_id":id,
"service_type":"hosting_wedos_protection",
"wdns_data":{
"domain":"nazev_domeny.tld",
"rows_a":{
"rem":{
"ID odebraného záznamu typu A":{
"name":"název odebraného záznamu typu A",
"ttl":"TTL odebraného záznamu typu A",
"rdtype":"A",
"rdata":"IP odebraného záznamu typu A"
}
},
"add":{
"ID přidaného záznamu typu A":{
"name":"název přidaného záznamu typu A",
"ttl":"TTL přidaného záznamu typu A",
"rdtype":"A",
"rdata":"IP přidaného záznamu typu A"
}
},
"stay":[ "seznam nepřepisovaných adres" ]
},
"rows_aaaa":
"rem":{
"ID odebraného záznamu typu AAAA":{
"name":"název odebraného záznamu typu AAAA",
"ttl":"TTL odebraného záznamu typu AAAA",
"rdtype":"AAAA",
"rdata":"IP odebraného záznamu typu AAAA"
}
},
"add":{
"ID přidaného záznamu typu AAAA":{
"name":"název přidaného záznamu typu AAAA",
"ttl":"TTL přidaného záznamu typu AAAA",
"rdtype":"AAAA",
"rdata":"IP přidaného záznamu typu AAAA"
}
},
"stay":[ "seznam nepřepisovaných adres" ]
}
}
}
}
}
wgp-domain-update-subscription
Příkazem wgp-domain-update-subscription změníte tarif nebo fakturační období služby WEDOS Global.
Parametry
- service_id = ID služby (povinný)
- variant_id = varianta služby (nepovinný) – 1 = Start, 2 = Advanced, 3 = Expert
- period_id = perioda (nepovinný) – 1 = měsíční, 4 = roční
Pro správné fungování příkazu zadejte aspoň jeden z parametrů variant_id nebo period_id.
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2101 = hodnota parametru není správná
- 2203 = hodnota parametru period_id není správná
- 2273 = hodnota parametru variant_id není správná
- 2400 = interní chyba – neevidovaný návratový kód
- 2406 = doména/služba nebyla nalezena
- 2408 = chybí patrametr variant_id nebo period_id
Návratová data
- domain = název 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 varianty služby
- period_id = ID periody předplatného
- dirty = příznak provedení změny (0 = nezměněno, 1 = změněno)
wgp-domain-update-subscription JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-update-subscription",
"clTRID": "vlastní id kód",
"data": {
"service_id": "ID služby",
"variant_id": "1 = Start, 2 = Advanced, 3 = Expert",
"period_id": "1 = měsíční fakturace, 4 = roční"
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-update-subscription",
"data":{
"domain": "nazev_domeny.tld",
"domain_id": ID domény,
"wedos_client_id": "ID zákazníka",
"service_id": ID služby,
"service_type": "kód typu služby",
"variant_id": ID tarifu,
"period_id": ID fakturačního období,
"dirty": 0|1
}
}
}
wgp-domain-retry
Příkazem wgp-domain-retry opakujete požadavek na vystavení certifikátu. Můžete jím vyřešit stav error_crt vrácený příkazem wgp-domain-info.
Parametry
- domain = název domény (povinné)
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2292 = doména pro tento zákaznický účet nebyla ve WGP nalezena
- 2400 = interní chyba
- 4000 = interní chyba
Návratová data
- domain = Název domény
- domain_id = ID domény ve WGP
- wedos_client_id = ID zákazníka
wgp-domain-retry JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-retry",
"clTRID": "vlastní id kód",
"data": {
"domain": "nazev_domeny.tld"
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-retry",
"data":{
"domain": "nazev_domeny.tld",
"domain_id": ID domény,
"wedos_client_id": "ID zákazníka"
}
}
}
wgp-domain-cache-purge
Příkazem wgp-domain-cache-purge promažete cache domény na WEDOS Global Protection.
Parametry
- service_id = ID služby (povinný)
- service_type = Typ služby (nepovinný)
- hodnoty: hosting_wedos_protection (výchozí), hosting_domain
- limiter_decay = Čas v sekundách pro omezení této funkce (nepovinný)
- výchozí hodnota 5
- limiter_reset = Zrušit omezení této funkce (nepovinný)
- 0 (ne, výchozí hodnta), 1 (ano)
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2101 = hodnota parametru není správná
- 2274 = interní chyba – parametr user_id chybí
- 2400 = interní chyba – neevidovaný návratový kód
- 2406 = doména/služba nebyla nalezena
- 2415 = omezení se blíží ke konci
- 4000 = systémová chyba
Návratová data
- domain = Název 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, kdy bude možné funkci znova použít
wgp-domain-cache-purge JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-cache-purge",
"clTRID": "vlastní id kód",
"data": {
"service_id": ID služby,
"service_type": "kód typu služby (nepovinné)",
"limiter_decay": timeout limiteru (v sekundách, nepovinné),
"limiter_reset": 0|1 (nepovinné)
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-cache-purge",
"data":{
"domain":"nazev_domeny.tld",
"domain_id": ID domény,
"domain_tld":"tld",
"wedos_client_id":"ID zákaznického účtu"
}
}
}
wgp-domain-template-replicate
Příkazem wgp-domain-template-replicate změníte nastavení cílové domény podle vybrané šablonovací domény.
Parametry
- service_id – ID služby (povinný)
- template_domain_id – ID šablonovací domény, ze které bude replikace provedena (povinný)
- service_type – typ služby (nepovinný)
- hodnoty: hosting_domain, hosting_wedos_protection
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2101 = hodnota parametru není správná
- 2400 = nespecifikovaná chyba
- 2401 = neplatná doména pro replikaci
- 2402 = neplatná šablonovací doména
- 2403 = nesrovnalost uživatele mezi doménou a šablonovací doménou
- 2404 = nesrovnalost plánu předplatného mezi doménou a šablonovací doménou
- 2405 = dosažen denní limit
- 2406 = doména/služba nebyla nalezena
- 2407 = šablonovací doména nebyla nalezena
- 4000 = systémová chyba
Návratová data
- domain = název domény
- domain_id = ID domény
- service_id = ID služby
- service_type = typ služby
- template_domain_id = ID šablonovací domény
- replications_count = počet provedených replikací
- replications_limit = maximální počet replikací
wgp-domain-template-replicate JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-template-replicate",
"clTRID": "vlastní id kód",
"data": {
"service_id": ID služby,
"template_domain_id": ID šablonovací domény,
"service_type": "hosting_domain, nebo hosting_wedos_protection (nepovinný)"
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-template-replicate",
"data":{
"domain":"nazev_domeny.tld",
"domain_id": ID domény,
"service_id": ID služby,
"service_type": "typ služby",
"template_domain_id": ID šablonovací domény,
"replications_count": počet provedených replikací,
"replications_limit": maximální počet replikací
}
}
}
wgp-domain-templates-list
Příkazem wgp-domain-templates-list získáte seznam šablonovacích domén k vybranému tarifu.
Parametry
- variant_id = ID tarifu (povinný)
- per_page = Počet záznamů na jednu stránku (výchozí = 15, získání všech záznamů = -1) (nepovinný)
- page = Číslo stránky (výchozí = 1) (nepovinný)
- locale = Jazyk pro stránkování (výchozí = en, podporované = cs, en) (nepovinný)
- search = Vyhledávání podle sloupců custom_name, name (nepovinný)
Návratové hodnoty
- 1000 = OK
- 2100 = chybí vyžadovaný parametr
- 2400 = interní chyba
- 4000 = interní chyba
Návratová data
- data = Seznam šablonovacích domén
- id = ID šablonovací domény
- custom_name = Uživatelský název šablonovací domény
- name = Název šablonovací domény
- url = URL šablonovací domény
- first_page_url = URL první stránky seznamu
- from = Začátek stránkování
- last_page = Číslo poslední stránky
- last_page_url = URL poslední stránky seznamu
- links = Pole nastavení tlačítek pro stránkování
- url = URL odkazu
- label = Popisek tlačítka
- active = null|1
- next_page_url = URL následující stránky
- path = URL se seznamem šablonovacích domén
- per_page = Počet záznamů na jednu stránku
- prev_page_url = URL předchozí stránky
- to = Konec stránkování
- total = Počet stránek celkem
wgp-domain-templates-list JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-domain-templates-list",
"clTRID": "vlastní id kód",
"data": {
"variant_id": ID tarifu 1 = Start, 2 = Advanced, 3 = Expert,
"per_page": počt záznamů na 1 stránku (nepovinný),
"page": číslo stránky (nepovinný),
"locale": "jazyk pro stránkování (cs, nebo en) (nepovinný)",
"search": "Vyhledávání podle sloupců custom_name, name (nepovinný)"
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command": "wgp-domain-templates-list",
"data":{
[
{
"id": ID šablonovací domény,
"custom_name":"uživatelský název šablonovací domény",
"name":"nazev-sablony.template",
"url":"https:\/\/url.sablonovaci.domeny\/nazev-domeny.template"
}
],
"first_page_url":"https:\/\/url.prvni.stranky.seznamu",
"from": číslo první stránky,
"last_page": číslo polední stránky,
"last_page_url":"https:\/\/url.posledni.stranky.seznamu",
"links":[
{
"url": "https:\/\/url.stranky",
"label":"Popisek ovládacího prvku",
"active": null|1
}
],
"next_page_url": "https:\/\/url.nasledujici.stranky",
"path":"https:\/\/url.seznamusablonovacich.domen",
"per_page": počet záznamů na stránku,
"prev_page_url":"https:\/\/url.predchozi.stranky",
"to": poslední prvek výpisu,
"total": počet stránek celkem
}
}
}
wgp-services-list
Příkazem wgp-services-list vypíšete seznam domén se službou WEDOS Global z administrace, můžete filtrovat podle statusu.
Parametry
- status = status služby (nepovinný)
Návratové hodnoty
- 1000 = OK
- 2206 = interní chyba – neznámý uživatel
Návratová data
- ID = ID záznamu domény
- name = jméno domény
- status = status domény
- expiration = datum expirace služby WG
Šablony
wgp-services-list JSON
JSON příkaz
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "wgp-services-list",
"clTRID": "vlastní id kód",
"data": {
"status": "pending_dns, processing, stuck, pending_txt, pending_ns, pending_dns_refresh, pending_crt, error_crt nebo active",
}
}
}
JSON odpověď (OK)
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF čas",
"clTRID": "vlastní id kód",
"svTRID": "id kód serveru",
"command":"wgp-services-list",
"data":{
"číselné ID služby v systému":{
"ID":"číselné ID služby v systému",
"domain":"nazev_domeny.tld",
"status":"status služby",
"expiration": "datum expirace YYYY-MM-DD"}
}
}
}