REST API – Domeny WEDOS.protection

GET /domains/{domain}

Zwraca informacje o jednej domenie podłączonej do WGP – połączenie danych z zewnętrznej administracji WEDOS Global Protection i wewnętrznej bazy danych WEDOS.

Parametry:

• domain – wymagany, path – nazwa domeny

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2202 – nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2292 – domena nie istnieje w WGP dla tego konta klienta
• 2400 – błąd wewnętrzny – niezarejestrowany kod zwrotny z WGP API (patrz Uwagi)
• 2418 – dla domeny w stanie Pending_TXT brak rekordu TXT

Dane odpowiedzi:

• wgp – dane domeny z zewnętrznej administracji WGP (np. stan domeny, flaga konta administratora i inne; elementy wedos_client_id i cms są usuwane z odpowiedzi)
• service – dane domeny z wewnętrznej bazy danych: ID, name, num, user_id, lang, currency, dane kontaktowe rozliczeniowe (cli_*) i właściciela (own_*), status, expiration

Przykład:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "wgp": {
      "domain": "domain1.tld",
      "state": "active",
      "user_admin": false
    },
    "service": {
      "ID": 435,
      "name": "domain1.tld",
      "num": "2026123456",
      "user_id": 10234,
      "lang": "cs",
      "currency": "CZK",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  }
}

GET /domains/templates

Zwraca stronicowaną listę domen szablonowych dostępnych dla danego wariantu usługi WGP. Służy jako źródło wartości template_domain_id przy zakładaniu domeny lub replikacji ustawień.

Parametry:

• variant_id – wymagany, query – ID wariantu usługi WGP (patrz lista kodów hosting_wedos_protection.variants )
• per_page – opcjonalny, query – liczba rekordów na stronę; domyślnie 15, wartość -1 zwraca wszystkie rekordy
• page – opcjonalny, query – numer strony; domyślnie 1
• locale – opcjonalny, query – język stronicowania, dozwolone wartości cs, en; domyślnie en
• search – opcjonalny, query – wyszukiwany ciąg znaków w kolumnach custom_name, name

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru (variant_id)
• 2400 – błąd wewnętrzny – niezarejestrowany kod zwrotny

Dane odpowiedzi:

• data – tablica domen szablonowych; każdy element zawiera id, custom_name, name, url
• per_page, total, last_page, from, to – szczegóły stronicowania
• first_page_url, prev_page_url, next_page_url, last_page_url, path – odnośniki do poszczególnych stron
• links – tablica elementów stronicowania (url, label, active)

Przykład:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/templates?variant_id=1'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "data": [
      {
        "id": 123,
        "custom_name": "Sample e-shop",
        "name": "template-eshop.wedos.com",
        "url": "https://template-eshop.wedos.com"
      }
    ],
    "per_page": 15,
    "total": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "path": "https://api.wedos.com/v2/wgp/domains/templates",
    "first_page_url": "https://api.wedos.com/v2/wgp/domains/templates?page=1",
    "prev_page_url": null,
    "next_page_url": null,
    "last_page_url": "https://api.wedos.com/v2/wgp/domains/templates?page=1",
    "links": [
      {"url": null, "label": "« Previous", "active": false},
      {"url": "https://api.wedos.com/v2/wgp/domains/templates?page=1", "label": "1", "active": true},
      {"url": null, "label": "Next »", "active": false}
    ]
  }
}

POST /domains/info

Zwraca informacje o jednej lub kilku domenach w WGP (odpowiednik GET /domains/{domain}, ale w treści żądania można podać kilka domen oddzielonych przecinkami).

Parametry:

• domain – wymagany – nazwa domeny lub kilka nazw oddzielonych przecinkami (np. "domain1.tld,domain2.tld")

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2202 – nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2292 – domena nie istnieje w WGP dla tego konta klienta
• 2400 – błąd wewnętrzny – niezarejestrowany kod zwrotny z WGP API
• 2418 – dla domeny w stanie Pending_TXT brak rekordu TXT

Dane odpowiedzi: Dla jednej domeny taka sama struktura jak w GET /domains/{domain} (klucze wgp i service). Dla kilku domen odpowiedzią jest obiekt z kluczami będącymi nazwami domen, gdzie każdy element ma ponownie strukturę wgp i service .

Przykład:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/domains/info' \
  --data '{"domain":"domain1.tld,domain2.tld"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain1.tld": {
      "wgp": {"domain": "domain1.tld", "state": "active", "user_admin": false},
      "service": {"ID": 435, "name": "domain1.tld", "status": "active", "expiration": "2027-10-01 00:00:00"}
    },
    "domain2.tld": {
      "wgp": {"domain": "domain2.tld", "state": "active", "user_admin": false},
      "service": {"ID": 436, "name": "domain1.tld", "status": "active", "expiration": "2027-03-15 00:00:00"}
    }
  }
}

POST /domains/create

Zakłada nową domenę w WGP. Można tego użyć także do przywrócenia domeny, która została zawieszona (stan disabled), ponieważ jej konfiguracja nie została dokończona na czas po utworzeniu.

Parametry:

• domain – wymagany – nazwa domeny
• variant_id – wymagany, liczba – ID wariantu usługi (patrz lista kodów hosting_wedos_protection.variants )
• period_id – wymagany, liczba – ID okresu abonamentowego
• upstream_ips – opcjonalny, tablica – tablica adresów IP, które nie będą kierowane do WGP
• template_domain_id – opcjonalny, liczba – ID domeny szablonowej użytej do konfiguracji nowej domeny
• mode – opcjonalny, string – tryb domeny, dozwolone wartości ns lub cname

Kody zwrotne:

• 1000 – OK (przywrócenie wcześniej zawieszonej domeny ze stanu disabled )
• 1001 – żądanie przyjęte, zakładanie domeny jest przetwarzane
• 2101 – nieprawidłowa wartość parametru
• 2202 – nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2203 – nieprawidłowa wartość period_id
• 2272 – nieprawidłowy format adresu IP (upstream_ips)
• 2273 – nieprawidłowa wartość variant_id
• 2276 – nieobsługiwana TLD
• 2277 – jawne www. w nazwie domeny jest niedozwolone
• 2278 – usługa dla tej domeny już istnieje
• 2279 – konto kredytowe jest zablokowane
• 2281 – konto kredytowe nie jest aktywne
• 2282 – nie można zapłacić z konta kredytowego w podanej walucie
• 2283 – niewystarczające saldo konta kredytowego
• 2284 – błąd w danych kontaktowych konta kredytowego
• 2285 – nieprawidłowe ustawienie rozliczania z VAT/bez VAT
• 2291 – domena już istnieje w WGP dla tego konta klienta
• 2293 – nie można pobrać salda konta kredytowego
• 2294 – nie można pobrać ceny usługi
• 2416 – nieprawidłowy tryb domeny (mode)
• 2417 – nieprawidłowy lub nieobsługiwany format nazwy subdomeny
• 2422 – nie można określić typu konta (admin/klient)
• 2423 – błąd wewnętrzny podczas wywołania WGP API
• inne kody błędów specyficzne dla operacji (np. walidacja replikacji domeny szablonowej 2401–2405)

Dane odpowiedzi:

• WGP_ID – ID domeny w WGP
• domain – nazwa domeny
• order_num – numer zamówienia (chyba że domena jest zakładana bezpłatnie lub przez konto administratora; także przy przywracaniu ze stanu disabled )
• currency, amount – waluta i kwota pobrana z konta kredytowego
• acc_amount_before, acc_amount_current – saldo konta kredytowego przed płatnością i po niej
• desc – opis (obecny tylko przy przywracaniu domeny ze stanu disabled )

Przykład:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/domains/create' \
  --data '{"domain":"domain1.tld","variant_id":1,"period_id":1,"mode":"ns"}'

{
  "code": 1001,
  "msg": "Request pending",
  "request_id": "a1b2c3d4",
  "data": {
    "WGP_ID": 98765,
    "domain": "domain1.tld",
    "order_num": "2026123456",
    "currency": "CZK",
    "amount": -499,
    "acc_amount_before": 1500,
    "acc_amount_current": 1001
  }
}

POST /domains/{domain}/create/retry

Ponawia zakładanie domeny zakończone błędem (dostępne tylko dla niektórych stanów domeny, np. error_crt).

Parametry:

• domain – wymagany, path – nazwa domeny

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2292 – domena nie istnieje w WGP dla tego konta klienta
• 2400 – błąd wewnętrzny – niezarejestrowany kod zwrotny

Dane odpowiedzi:

• domain – nazwa domeny
• domain_id – ID domeny w WGP
• wedos_client_id – ID klienta w WGP

Przykład:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld/create/retry'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234
  }
}

POST /domains/{domain}/delete-order

Usuwa niedokończone zamówienie domeny – stan, w którym domena utknęła w WGP bez możliwości dokończenia aktywacji, a lokalna usługa jeszcze nie istnieje.

Parametry:

• domain – wymagany, path – nazwa domeny

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2292 – nie znaleziono domeny w WGP dla tego konta klienta
• 2400 – błąd wewnętrzny
• 2410 – nie znaleziono usługi
• 2421 – usługa WGP już istnieje, domena nie zostanie usunięta

Dane odpowiedzi:

• domain – nazwa domeny
• domain_id – ID domeny w WGP
• wedos_client_id – ID klienta w WGP

Przykład:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld/delete-order'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234
  }
}