WAPI – WEDOS Global

  WAPI (API rozhraní)

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říkazem wgp-domain-create vytvoříte záznam domény ve službě WEDOS Global.

Parametry

  • name = název domény (povinný)
  • variant_id = varianta služby (povinný) – 1 = Start, 2 = Advanced, 3 = Expert
  • period_id = perioda (povinný) – 1 = měsíční, 4 = roční
  • upstream_ips = pole IP adres, které se na WG nebudou resolvovat (nepovinný)
  • 1000 = OK
  • 1001 = požadavek se vyřizuje
  • 2101 = hodnota parametru není správná
  • 2202 = chybný nebo nepodporovaný formát jména domény
  • 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
  • 228? = chyby zálohového účtu
  • 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
  • 2295 = interní chyba – nelze vytvořit doménu ve WGP
  • 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

Š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": {
      "name": "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é)"]
    }
  }
}
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 domény ve službě WEDOS Global.

Parametry

  • name = název domény (povinný)
  • 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
  • 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
    • 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": {
      "name": "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-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ý)
  • 1000 = OK
  • 2206 = interní chyba – neznámý uživatel
  • 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, 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",
        "name":"nazev_domeny.tld",
        "status":"status služby",
        "expiration": "datum expirace YYYY-MM-DD"}
    }
  }
}

Děkujeme za zpětnou vazbu!