WEDOS REST API est encore en développement. L’accès et les fonctionnalités peuvent changer sans préavis.
Cet article décrit partiellement l’endpoint WEDOS.protection de WEDOS REST API. Les domaines WEDOS.protection et les services ont leurs propres articles. Pour WEDOS API (WAPI), voir WAPI – WEDOS Protection.
Vous trouverez les informations de base sur WEDOS REST API dans l’article Manuel WEDOS REST API.
Dans cet article, vous trouverez les informations suivantes :
- Accès à l’endpoint DNS
- Détails de l’endpoint DNS :
- Remarques
Accès à l’endpoint WGP
WGP HTTP REST API v2 sert à gérer les domaines, les services et les invitations à la cogestion dans WEDOS.protection (WGP).
URL de base et authentification
L’URL de base des endpoints WGP est : https://api.wedos.com/v2
L’authentification repose uniquement sur OAuth2 : indiquez un token d’accès valide dans l’en-tête de la requête (Authorization: Bearer <TOKEN>) avec le scope wgp . Sans token valide, l’API renvoie l’erreur 2000.
Vous pouvez ajouter le paramètre example=1 à n’importe quel endpoint comme paramètre GET (?example=1 pour les endpoints sans paramètres GET propres, sinon &example=1). L’API renvoie alors un exemple de commande curl pour cet appel, sans qu’il soit nécessaire de fournir de vrais paramètres. Une authentification valide est requise même dans ce mode.
Aperçu des endpoints
| Méthode | Endpoint | Description |
|---|---|---|
| POST | /members | Création d’une invitation à la cogestion d’un domaine |
| GET | /members/{email} | Affichage d’une invitation à la cogestion |
| DELETE | /members/{email} | Suppression d’une invitation à la cogestion |
Format de la réponse
La réponse de l’API est toujours un objet JSON avec les clés code (code de retour), msg (description textuelle), request_id (identifiant de la requête) et, le cas échéant, data (données renvoyées en cas de succès).
Codes de retour généraux valables pour tous les endpoints (couche REST, indépendamment de l’opération concernée) :
1000– succès (OK)2000– authentification (token OAuth2 Bearer) manquante ou invalide2004– taille maximale de la requête dépassée (URL ou corps de la requête)4000– méthode API inconnue ou non prise en charge (la combinaison appelée de méthode HTTP et de chemin n’existe pas)4001– la validation des données d’entrée a échoué4005– aucun exemple n’est disponible pour cet endpoint avec le modeexample=1mode6000– erreur interne lors de l’initialisation de la commande WAPI sous-jacente
Chaque endpoint renvoie en outre ses propres codes métier liés à l’opération (correspondant à la commande WAPI sous-jacente). Ils sont indiqués sous Codes de retour pour chaque endpoint.
POST /members
Crée une invitation à cogérer un ou plusieurs domaines WGP pour l’adresse e-mail indiquée.
Paramètres :
email– requis – adresse e-mail pour laquelle l’invitation est crééepolicies– requis, objet – un tableau associatif de la forme{domain or "*" (all domains) => 0/1}, par ex.{"domain1.tld":1}ou{"*":1}; il ne s’agit pas d’un simple tableau de noms de domaines
Codes de retour :
1000– OK2223– format d’adresse e-mail invalide ou adresse inexistante2419– invitation introuvable2420– tableau de règles ou de conditions de domaine invalide (policies)2424– l’adhésion existe déjà2400– erreur interne – code de retour non enregistré
Données de la réponse :
email– adresse e-mail de l’invitationurl– URL de confirmation de l’invitationpolicies_count– nombre de règles indiquées
Exemple :
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}
Affiche une invitation existante à la cogestion d’un domaine pour l’adresse e-mail indiquée.
Paramètres :
email– requis, path, encodé pour URL (par ex.%40pour@) – adresse e-mail de l’invitation
Codes de retour :
1000– OK2223– format d’adresse e-mail invalide ou adresse inexistante2419– invitation introuvable2400– erreur interne – code de retour non enregistré
Données de la réponse :
email– adresse e-mail de l’invitationurl– URL de confirmation de l’invitationpolicies_count– nombre de règles indiquées
Exemple :
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}
Supprime une invitation existante à la cogestion d’un domaine pour l’adresse e-mail indiquée.
Paramètres :
email– requis, path, encodé pour URL – adresse e-mail de l’invitation
Codes de retour :
1000– OK2223– format d’adresse e-mail invalide ou adresse inexistante2419– invitation introuvable2400– erreur interne – code de retour non enregistré
Données de la réponse :
email– adresse e-mail de l’invitation supprimée
Exemple :
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"
}
}Remarques
- Ni POST /members ni GET /members/{email} ne renvoient jamais le contenu des policies indiquées dans leur réponse – seulement email, url et policies_count. C’est le comportement de l’administration WGP externe, et non une limitation de cette couche REST.