WAPI - Ochrona WEDOS (WGP)

Ten artykuł zawiera informacje na temat następujących poleceń:

• wgp-domain-create - dodaje domenę do WEDOS Protection
• wgp-domain-info - lista informacji o domenie WEDOS Protection
• wgp-domain-renew - odnowienie usługi
• wgp-domain-delete - zakończenie usługi
• wgp-domain-update-subscription - zmiana planu
• wgp-domain-retry - rozwiązanie niektórych błędów
• wgp-domain-cache-purge - czyszczenie pamięci podręcznej WP
• wgp-domain-template-replicate - replikuje szablon do istniejącej domeny.
• wgp-domain-templates-list - lista szablonów domeny
• wgp-services-list - lista domen ochrony WEDOS

---

wgp-domain-create

Użyj żądania wgp-domain-create, aby utworzyć rekord domeny w usłudze WEDOS Protection. To żądanie jest asynchroniczne i komunikuje się za pośrednictwem powiadomień ⧉.

Parametry

• domain = nazwa domeny (wymagane)
• variant_id = plan usługi (wymagany) - 1 = Start, 2 = Advanced, 3 = Expert(plany i ich ceny można znaleźć na stronie produktu ⧉)
• period_id = okres świadczenia usługi (wymagane) - 1 = miesięcznie, 4 = rocznie
• upstream_ips = tablica docelowych adresów IP (opcjonalnie) - więcej informacji na temat docelowych adresów IP można znaleźć w artykule Ochrona - DNS i docelowe adresy IP.
• template_domain_id = identyfikator domeny szablonu (opcjonalnie)
• tryb = tryb domeny (opcjonalnie)
  • ns = używa WEDOS NS (domyślnie); system aktywuje domenę tylko wtedy, gdy pomyślnie sprawdzi, że używa WEDOS DNS.
  • cname = umożliwia korzystanie z serwerów DNS innego dostawcy lub dodawanie subdomen za pośrednictwem rekordu CNAME; trybem dla dowolnej domeny trzeciego lub wyższego poziomu jest zawsze cname.

Zwracane wartości

• 1000 = OK
• 1001 = żądanie oczekujące
• 2101 = Niezgodność parametrów
• 2202 = Nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2203 = Nieprawidłowy period_id
• 2206 = Nieprawidłowe żądanie - błąd wewnętrzny
• 2272 = Nieprawidłowy format adresu IP
• 2273 = Nieprawidłowy wariant
• 2274 = Błąd wewnętrzny - brak parametru user_id
• 2275 = Błąd wewnętrzny - nie znaleziono użytkownika
• 2276 = Nieobsługiwana TLD lub przekroczony maksymalny poziom domeny
• 2277 = niedozwolone jawne dodawanie www. przed nazwą domeny
• 2278 = Nazwa domeny nie może być użyta - istnieje usługa z tą nazwą domeny.
• 2279 = konto kredytowe jest zablokowane
• 2280 = aktywne konto kredytowe
• 2281 = Nieaktywny rachunek kredytowy
• 2282 = Nieprawidłowa waluta rachunku kredytowego
• 2283 = Nieprawidłowa kwota lub niewystarczający kredyt
• 2284 = Błąd informacji o koncie kredytowym
• 2285 = Nieprawidłowe ustawienia VAT
• 2286 = Konto kredytowe - błąd wewnętrzny
• 2290 = Rachunek kredytowy - aktywność nie została dodana do rachunku kredytowego.
• 2291 = Domena już istnieje dla tego konta klienta w interfejsie API WGP.
• 2293 = Nie można uzyskać salda kredytowego na rachunku kredytowym
• 2294 = Nie można wycofać ceny usługi
• 2295 = Nie można utworzyć domeny dla WGP. Płatność została anulowana.
• 2296 = Nie można anulować ruchu na rachunku kredytowym
• 2400 = Wewnętrzny błąd WGP
• 2401 = Nie można zastosować szablonu do domeny
• 2402 = Nieprawidłowy szablon domeny
• 2403 = niezgodność szablonu domeny i użytkownika
• 2404 = Niedopasowanie szablonu domeny i planu domeny
• 2405 = Osiągnięto dzienną domenę szablonu
• 2416 = Nieprawidłowy tryb domeny

Dane odpowiedzi

• WGP_ID = identyfikator rekordu domeny WGP
• domena = nazwa domeny
• order_num = numer zamówienia
• waluta = waluta rachunku kredytowego
• kwota = cena usługi
• acc_amount_before = saldo konta przed aktywacją usługi
• acc_amount_current = saldo konta kredytowego po aktywacji usługi

Dane odpowiedzi na powiadomienie

• WGP_ID = identyfikator rekordu domeny WGP
• domena = nazwa domeny
• order_num = numer zamówienia

Szablony

Żądanie JSON:

{
  "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)"
    }
  }
}

Odpowiedź JSON (żądanie w toku):

{
  "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"
    }
  } 
}

Powiadomienie JSON po zakończeniu konfiguracji:

{
  "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

Użyj żądania wgp-domain-info, aby wyświetlić informacje o stanie domeny w usłudze WEDOS Protection.

Parametry

• domain = nazwa domeny (wymagane)

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2202 = Nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2206 = Nieprawidłowe żądanie - błąd wewnętrzny
• 2292 = Nie znaleziono domeny dla tego konta klienta w interfejsie API WGP.

Dane odpowiedzi

• wgp = status domeny w usłudze WEDOS Protection stan parametr ma jedną z następujących wartości, z których niektóre mogą zawierać różne dane:
  • pending_dns = trwa rozpoznawanie rekordów DNS domeny
  • przetwarzanie = oczekiwanie na konfigurację usługi
  • Utknięcie = oczekiwanie na wymagania dotyczące oprogramowania
  • pending_txt = oczekiwanie na weryfikację rekordu TXT(szablon częściowy)
  • pending_ns = oczekiwanie na konfigurację serwera nazw(częściowy szablon dla trybu NS i CNAME)
  • pending_dns_refresh = ponowne rozwiązywanie DNS, jeśli poprzednie pending_dns nie znalazło żadnych rekordów DNS
  • pending_crt = oczekiwanie na certyfikat Let's Encrypt dla WG
  • active = domena aktywna(pełny szablon)
• service = status domeny w systemie WEDOS

Bardziej szczegółowe informacje na temat danych zwrotnych można znaleźć w szablonie.

Szablony

Żądanie JSON:

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

Odpowiedź JSON (OK, stan aktywny):

{
  "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"
      }
    }
  }
}

Dane JSON (OK, stan 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"
        }
    }
}

Dane JSON (OK, stan pending_ns w trybie ns ):

{
    ...
    "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"
        }
    }
}

Dane JSON (OK, stan pending_ns w cname tryb; crt_name oraz cname to nazwy rekordów i wartości, które użytkownik może ustawić u swojego dostawcy 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

Użyj żądania wgp-domain-renew, aby przedłużyć domenę w usłudze WEDOS Protection na kolejny okres.

Parametry

• service_id = identyfikator usługi (wymagane)

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2152 = Odnowienie usługi zablokowane
• 2206 = Brakujący identyfikator użytkownika
• 2279 = konto kredytowe zablokowane
• 2281 = Nieaktywny rachunek kredytowy
• 2282 = Nieprawidłowa waluta rachunku kredytowego
• 2283 = Nieprawidłowa kwota lub niewystarczający kredyt
• 2284 = Błąd informacji o koncie kredytowym
• 2286 = Konto kredytowe - błąd wewnętrzny
• 2293 = Nie można uzyskać salda kredytowego na rachunku kredytowym
• 2406 = Nie znaleziono domeny/usługi
• 2409 = Odnowienie usługi nie powiodło się

Dane odpowiedzi

• service_id = identyfikator usługi
• name = Nazwa domeny
• date_from = data ważności usługi
• date_to = data wygaśnięcia usługi
• fakt_order_num = Numer zamówienia odnowienia usługi
• waluta = waluta rachunku kredytowego
• cena = cena odnowienia
• kredyt = saldo kredytowe konta po odnowieniu

Szablony

Żądanie JSON:

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

Odpowiedź JSON (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

Polecenie wgp-domain-delete służy do usuwania domeny z usługi WEDOS Protection.

Parametry

• service_id = identyfikator usługi (wymagane)
• force = Wymuś usunięcie niezależnie od rekordów domeny A/AAA (opcjonalnie, jeśli istnieje token do przepisywania rekordów DNS).

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2274 = Błąd wewnętrzny - brak parametru user_id
• 2292 = Domena nie została znaleziona na tym koncie użytkownika
• 2400 = Błąd wewnętrzny
• 2410 = Nie znaleziono usługi
• 2411 = niedostępny token do przepisania DNS
• 2412 = Nieudane żądanie API przepisania DNS
• 2413 = Żądanie nie powiodło się, WGP nie ma uprawnień do aktualizacji DNS
• 2414 = WGP nie ma tokena, a użytkownik nie ustawił flagi force w WAPI.

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = identyfikator domeny
• wedos_client_id = identyfikator klienta
• service_id = identyfikator usługi
• service_type = typ usługi
• wdns_data = tablica aktualizacji adresów IP

Szablony

Żądanie JSON:

{
  "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)
    }
  }
}

Odpowiedź JSON (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-update-subscription

Użyj żądania wgp-domain-update-subscription, aby zmienić plan lub okres rozliczeniowy usługi WEDOS Protection.

Parametry

• service_id = identyfikator usługi (wymagane)
• variant_id = plan serwisowy (opcjonalny) - 1 = Start, 2 = Advanced, 3 = Expert
• period_id = okres rozliczeniowy (opcjonalnie) - 1 = miesięczny, 4 = roczny

Aby żądanie działało poprawnie, należy wprowadzić co najmniej jeden z parametrów variant_id lub period_id.

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2203 = Nieprawidłowy period_id
• 2273 = Nieprawidłowy wariant
• 2400 = Wewnętrzny błąd WGP
• 2406 = Domena/usługa nie jest finansowana
• 2408 = Brakujący variant_id lub period_id

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = identyfikator domeny
• wedos_client_id = identyfikator klienta
• service_id = identyfikator usługi
• service_type = typ usługi
• variant_id = identyfikator planu usługi
• period_id = identyfikator okresu rozliczeniowego
• brudny = znacznik aktualizacji (0 = taki sam jak poprzednio, 1 = zmieniony)

Szablony

Żądanie JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-update-subscription",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "variant_id": "1 = Start, 2 = Advanced, 3 = Expert",
      "period_id": "1 = monthly billing, 4 = annual"
    }
  }
}

Odpowiedź JSON (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-retry

Za pomocą polecenia wgp-domain-retry można powtórzyć żądanie wydania certyfikatu. Można go użyć do rozwiązania statusu error_crt zwróconego przez polecenie wgp-domain-info.

Parametry

• domain = nazwa domeny (wymagane)

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2292 = Domena nie została znaleziona na tym koncie użytkownika
• 2400 = Błąd wewnętrzny
• 4000 = Błąd wewnętrzny

Dane odpowiedzi

• domain = nazwa domeny
• domain_id = identyfikator domeny w WGP
• wedos_client_id = identyfikator klienta

Szablony

Żądanie JSON:

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

Odpowiedź JSON (OK):

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

---

wgp-domain-cache-purge

Użyj wgp-domain-cache-purge, aby wyczyścić pamięć podręczną domeny WEDOS Protection.

Parametry

• service_id = identyfikator usługi (wymagane)
• service_type = Typ usługi (opcjonalnie)
  • wartości: hosting_wedos_protection (domyślnie), hosting_domain
• limiter_decay = czas blokowania w sekundach (opcjonalnie)
  • wartość domyślna 5
• limiter_reset = Ogranicznik anulowania (opcjonalnie)
  • 0 (nie, domyślnie), 1 (tak)

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2274 = błąd wewnętrzny - brak identyfikatora użytkownika
• 2400 = błąd wewnętrzny - nieznany kod powrotu
• 2406 = nie znaleziono domeny/usługi
• 2415 = osiągnięta wartość ogranicznika
• 4000 = błąd systemu

Dane odpowiedzi

• domain = nazwa domeny
• domain_id = identyfikator domeny
• domain_tld = TLD domeny
• service_id = identyfikator usługi
• wedos_client_id = identyfikator klienta
• limiter_available_in = czas w sekundach do ponownego udostępnienia funkcji

Szablony

Żądanie JSON:

{
  "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)
    }
  }
}

Odpowiedź JSON (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

Użyj żądania wgp-domain-template-replicate, aby zmienić ustawienia domeny docelowej zgodnie z wybraną domeną szablonu.

Parametry

• service_id - identyfikator usługi (wymagany)
• template_domain_id - identyfikator domeny szablonu docelowego (wymagane)
• service_type - typ usługi (opcjonalnie)
  • wartości: hosting_domain, hosting_wedos_protection

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2400 = Wewnętrzny błąd WGP
• 2401 = Nie można zastosować szablonu do domeny
• 2402 = Nieprawidłowy szablon domeny
• 2403 = niezgodność szablonu domeny i użytkownika
• 2404 = Niedopasowanie szablonu domeny i planu domeny
• 2405 = Osiągnięto dzienną domenę szablonu
• 2406 = Nie znaleziono domeny/usługi
• 2407 = Nie znaleziono domeny szablonu
• 4000 = Błąd wewnętrzny

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = identyfikator domeny
• service_id = identyfikator usługi
• service_type = typ usługi
• template_domain_id = identyfikator domeny szablonu
• replications_count = liczba wykonanych replikacji
• replications_limit = maksymalna liczba replikacji

Szablony

Żądanie JSON:

{
  "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)"
    }
  }
}

Odpowiedź JSON (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

Użyj żądania wgp-domain-templates-list, aby pobrać listę szablonów domen dla wybranego planu WEDOS Protection.

Parametry

• variant_id = identyfikator planu (wymagane)
• per_page = liczba rekordów na stronę (domyślnie = 15, pobierz wszystkie rekordy = -1) (opcjonalnie)
• page = numer strony (domyślnie = 1) (opcjonalnie)
• locale = język (domyślnie = en, obsługiwane = cs, en) (opcjonalnie)
• search = wyszukiwanie według kolumn custom_name, name (opcjonalnie)

Zwracane wartości

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2400 = błąd wewnętrzny
• 4000 = błąd wewnętrzny

Dane odpowiedzi

• dane = lista domen szablonu
  • id = identyfikator domeny szablonu
  • custom_name = nazwa domeny szablonu (ustawiona przez użytkownika)
  • name = nazwa domeny szablonu (system)
  • url = adres URL domeny szablonu
• first_page_url = adres URL pierwszej strony listy
• from = Początek paginacji
• last_page = Numer ostatniej strony
• last_page_url = adres URL ostatniej strony listy
• linki = łącze do stronicowania
  • url = adres URL łącza
  • label = Etykieta przycisku
  • active = null|1
• next_page_url = adres URL następnej strony
• path = adres URL listy domen szablonu
• per_page = Liczba wpisów na stronę
• prev_page_url = Adres URL poprzedniej strony
• do = koniec paginacji
• total = całkowita liczba stron

Szablony

Żądanie JSON:

{
  "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)"
    }
  }
}

Odpowiedź JSON (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

Za pomocą żądania wgp-services-list można pobrać listę domen z usługą WEDOS Protection. Można filtrować według stanu.

Parametry

• status = status usługi (opcjonalnie)

Zwracane wartości

• 1000 = OK
• 2206 = Nieprawidłowe żądanie - błąd wewnętrzny

Dane odpowiedzi

• ID = identyfikator rekordu domeny
• name = nazwa domeny
• status = status domeny
• wygaśnięcie = data wygaśnięcia usługi WG

Szablony

Żądanie JSON

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-create",
    "clTRID": "own ID code",
    "data": {
      "status": "pending_dns, processing, stuck, pending_txt, pending_ns, pending_dns_refresh, pending_crt, or active"
    }
  }
}

Odpowiedź JSON (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"
    }
  }
}