Die WEDOS REST API befindet sich noch in Entwicklung. Zugriff und Funktionen können sich ohne vorherige Ankündigung ändern.
Dieser Artikel beschreibt teilweise den WEDOS.protection-Endpoint der WEDOS REST API. WEDOS.protection Domains und Services haben eigene Artikel. Für WEDOS API (WAPI) siehe WAPI – WEDOS Protection.
Grundlegende Informationen zur WEDOS REST API finden Sie im WEDOS REST API Handbuch.
In diesem Artikel finden Sie die folgenden Informationen:
- Zugriff auf den DNS-Endpoint
- Details zum DNS-Endpoint:
- Hinweise
Zugriff auf den WGP-Endpoint
Die WGP HTTP REST API v2 dient zur Verwaltung von Domains, Services und Einladungen zur Mitverwaltung in WEDOS.protection (WGP).
Basis-URL und Authentifizierung
Die Basis-URL für die WGP-Endpoints lautet: https://api.wedos.com/v2
Die Authentifizierung erfolgt ausschließlich über OAuth2: Senden Sie ein gültiges Access-Token im Request-Header (Authorization: Bearer <TOKEN>) mit dem wgp Scope. Ohne gültiges Token liefert die API den Fehler 2000.
Sie können den Parameter example=1 an jeden Endpoint als GET-Parameter anhängen (?example=1 für Endpoints ohne eigene GET-Parameter, sonst &example=1). Die API liefert dann einen Beispiel-curl-Befehl für diesen Aufruf, ohne dass echte Parameter nötig sind. Auch in diesem Modus ist eine gültige Authentifizierung erforderlich.
Übersicht der Endpoints
| Methode | Endpoint | Beschreibung |
|---|---|---|
| POST | /members | Einladung zur Mitverwaltung einer Domain erstellen |
| GET | /members/{email} | Einladung zur Mitverwaltung anzeigen |
| DELETE | /members/{email} | Einladung zur Mitverwaltung löschen |
Antwortformat
Die API-Antwort ist immer ein JSON-Objekt mit den Schlüsseln code (Rückgabecode), msg (Textbeschreibung), request_id (Anfrage-Kennung) und gegebenenfalls data (bei Erfolg zurückgegebene Daten).
Allgemeine Rückgabecodes, die für alle Endpoints gelten (REST-Schicht, unabhängig von der konkreten Operation):
1000– Erfolg (OK)2000– Authentifizierung (OAuth2-Bearer-Token) fehlt oder ist ungültig2004– maximale Anfragegröße überschritten (URL oder Request-Body)4000– unbekannte/nicht unterstützte API-Methode (die aufgerufene Kombination aus HTTP-Methode und Pfad existiert nicht)4001– Eingabevalidierung fehlgeschlagen4005– kein Beispiel für den aktuellen Endpoint im Modusexample=1vorhanden6000– interner Fehler beim Initialisieren des zugrunde liegenden WAPI-Befehls
Darüber hinaus liefert jeder Endpoint eigene fachliche Codes, die für die jeweilige Operation spezifisch sind (entsprechend dem zugrunde liegenden WAPI-Befehl). Diese sind unter Rückgabecodes beim jeweiligen Endpoint aufgeführt.
POST /members
Erstellt für die angegebene E-Mail-Adresse eine Einladung zur Mitverwaltung einer oder mehrerer WGP-Domains.
Parameter:
email– erforderlich – E-Mail-Adresse, für die die Einladung erstellt wirdpolicies– erforderlich, Objekt – ein assoziatives Array in der Form{domain or "*" (all domains) => 0/1}, z. B.{"domain1.tld":1}oder{"*":1}; es ist kein einfaches Array von Domainnamen
Rückgabecodes:
1000– OK2223– ungültiges Format oder nicht existierende E-Mail-Adresse2419– Einladung nicht gefunden2420– ungültiges Array von Domain-Regeln/-Bedingungen (policies)2424– die Mitgliedschaft existiert bereits2400– interner Fehler – nicht registrierter Rückgabecode
Antwortdaten:
email– E-Mail-Adresse der Einladungurl– URL zur Bestätigung der Einladungpolicies_count– Anzahl der angegebenen Regeln
Beispiel:
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}
Zeigt eine bestehende Einladung zur Mitverwaltung einer Domain für die angegebene E-Mail-Adresse an.
Parameter:
email– erforderlich, Pfad, URL-kodiert (z. B.%40für@) – E-Mail-Adresse der Einladung
Rückgabecodes:
1000– OK2223– ungültiges Format oder nicht existierende E-Mail-Adresse2419– Einladung nicht gefunden2400– interner Fehler – nicht registrierter Rückgabecode
Antwortdaten:
email– E-Mail-Adresse der Einladungurl– URL zur Bestätigung der Einladungpolicies_count– Anzahl der angegebenen Regeln
Beispiel:
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}
Löscht eine bestehende Einladung zur Mitverwaltung einer Domain für die angegebene E-Mail-Adresse.
Parameter:
email– erforderlich, Pfad, URL-kodiert – E-Mail-Adresse der Einladung
Rückgabecodes:
1000– OK2223– ungültiges Format oder nicht existierende E-Mail-Adresse2419– Einladung nicht gefunden2400– interner Fehler – nicht registrierter Rückgabecode
Antwortdaten:
email– E-Mail-Adresse der gelöschten Einladung
Beispiel:
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"
}
}Hinweise
- Weder POST /members noch GET /members/{email} gibt jemals den Inhalt der angegebenen policies in der Antwort zurück – nur email, url und policies_count. Das ist das Verhalten der externen WGP-Verwaltung und keine Einschränkung dieser REST-Schicht.