WEDOS REST API jest wciąż w fazie rozwoju. Dostęp i funkcje mogą ulec zmianie bez wcześniejszego powiadomienia.
Ten artykuł częściowo opisuje endpoint WEDOS.protection w WEDOS REST API. Domeny WEDOS.protection i usługi mają własne artykuły. Informacje o WEDOS API (WAPI) zawiera artykuł WAPI – WEDOS Protection.
Podstawowe informacje o WEDOS REST API zawiera artykuł Podręcznik WEDOS REST API.
W tym artykule znajdują się następujące informacje:
- Dostęp do endpointu DNS
- Szczegóły endpointu DNS:
- Uwagi
Dostęp do endpointu WGP
WGP HTTP REST API v2 służy do zarządzania domenami, usługami i zaproszeniami do współzarządzania w WEDOS.protection (WGP).
Podstawowy adres URL i uwierzytelnianie
Podstawowy adres URL endpointów WGP to: https://api.wedos.com/v2
Uwierzytelnianie odbywa się wyłącznie przez OAuth2: w nagłówku żądania należy podać ważny token dostępu (Authorization: Bearer <TOKEN>) ze scope wgp . Bez ważnego tokenu API zwraca błąd 2000.
Można dodać parametr example=1 do dowolnego endpointu jako parametr GET (?example=1 dla endpointów bez własnych parametrów GET, w przeciwnym razie &example=1). API zwróci wtedy przykładowe polecenie curl dla tego wywołania, bez konieczności podawania prawdziwych parametrów. Również w tym trybie wymagane jest prawidłowe uwierzytelnienie.
Przegląd endpointów
| Metoda | Endpoint | Opis |
|---|---|---|
| POST | /members | Utworzenie zaproszenia do współzarządzania domeną |
| GET | /members/{email} | Wyświetlenie zaproszenia do współzarządzania |
| DELETE | /members/{email} | Usunięcie zaproszenia do współzarządzania |
Format odpowiedzi
Odpowiedź API jest zawsze obiektem JSON z kluczami code (kod zwrotny), msg (opis tekstowy), request_id (identyfikator żądania) oraz, jeśli dotyczy, data (dane zwracane przy powodzeniu).
Ogólne kody zwrotne obowiązujące dla wszystkich endpointów (warstwa REST, niezależnie od konkretnej operacji):
1000– powodzenie (OK)2000– brak lub nieprawidłowe uwierzytelnienie (token OAuth2 Bearer)2004– przekroczono maksymalny rozmiar żądania (URL lub treść żądania)4000– nieznana/nieobsługiwana metoda API (wywołana kombinacja metody HTTP i ścieżki nie istnieje)4001– walidacja danych wejściowych nie powiodła się4005– dla bieżącego endpointu w trybieexample=1nie jest dostępny żaden przykład6000– błąd wewnętrzny podczas inicjalizacji bazowego polecenia WAPI
Dodatkowo każdy endpoint zwraca własne kody biznesowe specyficzne dla danej operacji (odpowiadające bazowemu poleceniu WAPI). Są one wymienione w sekcji Kody zwrotne przy każdym endpoincie.
POST /members
Tworzy zaproszenie do współzarządzania jedną lub kilkoma domenami WGP dla podanego adresu e-mail.
Parametry:
email– wymagane – adres e-mail, dla którego tworzone jest zaproszeniepolicies– wymagane, obiekt – tablica asocjacyjna w postaci{domain or "*" (all domains) => 0/1}, np.{"domain1.tld":1}lub{"*":1}; nie jest to zwykła tablica nazw domen
Kody zwrotne:
1000– OK2223– nieprawidłowy format lub nieistniejący adres e-mail2419– nie znaleziono zaproszenia2420– nieprawidłowa tablica reguł/warunków domen (policies)2424– członkostwo już istnieje2400– błąd wewnętrzny – niezarejestrowany kod zwrotny
Dane odpowiedzi:
email– adres e-mail zaproszeniaurl– URL do potwierdzenia zaproszeniapolicies_count– liczba podanych reguł
Przykład:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/wgp/members' \
--data '{"email":"esmeralda@wedos.com","policies":{"domain1.tld":1}}'{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3d4",
"data": {
"email": "esmeralda@wedos.com",
"url": "https://wgp.wedos.com/invite/abc123def456",
"policies_count": 1
}
}GET /members/{email}
Wyświetla istniejące zaproszenie do współzarządzania domeną dla podanego adresu e-mail.
Parametry:
email– wymagane, w ścieżce, zakodowane w URL (np.%40zamiast@) – adres e-mail zaproszenia
Kody zwrotne:
1000– OK2223– nieprawidłowy format lub nieistniejący adres e-mail2419– nie znaleziono zaproszenia2400– błąd wewnętrzny – niezarejestrowany kod zwrotny
Dane odpowiedzi:
email– adres e-mail zaproszeniaurl– URL do potwierdzenia zaproszeniapolicies_count– liczba podanych reguł
Przykład:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/wgp/members/esmeralda%40wedos.com'{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3d4",
"data": {
"email": "esmeralda@wedos.com",
"url": "https://wgp.wedos.com/invite/abc123def456",
"policies_count": 1
}
}DELETE /members/{email}
Usuwa istniejące zaproszenie do współzarządzania domeną dla podanego adresu e-mail.
Parametry:
email– wymagane, w ścieżce, zakodowane w URL – adres e-mail zaproszenia
Kody zwrotne:
1000– OK2223– nieprawidłowy format lub nieistniejący adres e-mail2419– nie znaleziono zaproszenia2400– błąd wewnętrzny – niezarejestrowany kod zwrotny
Dane odpowiedzi:
email– adres e-mail usuniętego zaproszenia
Przykład:
curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/wgp/members/esmeralda%40wedos.com'{
"code": 1000,
"msg": "OK",
"request_id": "a1b2c3d4",
"data": {
"email": "esmeralda%40wedos.com"
}
}Uwagi
- Ani POST /members, ani GET /members/{email} nigdy nie zwraca w odpowiedzi zawartości podanych policies – tylko email, url i policies_count. Jest to zachowanie zewnętrznej administracji WGP, a nie ograniczenie tej warstwy REST.