La communication avec l’interface API s’effectue exclusivement via HTTPS, c’est-à-dire de manière chiffrée. Toutes les requêtes utilisent la méthode GET.
Certaines méthodes acceptent des paramètres d’entrée – ceux-ci sont insérés directement dans l’URL de la requête sous forme de paramètres GET.
URL et format de la réponse
L’interface API est disponible à l’adresse :
https://api.wedos.as/partner/{method_name}
Toutes les méthodes renvoient une réponse au format JSON.
Chaque réponse contient requestId, qui identifie de manière unique la requête concernée.
Toutes les données de la réponse sont encodées en UTF-8.
Grâce au requestId nous sommes en mesure, en cas de problème, de retrouver la communication concernée dans les journaux internes.
Authentification
Chaque requête API doit être authentifiée. Pour cela, on utilise clé API, qui fonctionne comme un mot de passe mais est destinée exclusivement à l’API.
La clé API n’est pas identique au mot de passe que vous utilisez pour vous connecter à l’administration partenaire.
Vous générez la clé API après vous être connecté à l’administration partenaire, dans la section
Compte, paramètres – Paramètres API.
En-têtes HTTP
L’authentification s’effectue à l’aide de deux en-têtes HTTP qu’il faut ajouter à chaque requête :
- X-Auth-Id – ID de la clé API
- X-Auth-Key – la clé API elle-même
Exemple de requête HTTPS
Voici un exemple de requête API simple, avec les en-têtes HTTP nécessaires.
Il s’agit de la méthode ping, qui vous permet de vérifier que la communication fonctionne correctement.
GET /partner/ping HTTP/1.1 Host: api.wedos.as Accept: application/json X-Auth-Id: KEYID X-Auth-Key: YOURKEY
Exemple de réponse
Lors d’un appel réussi de la méthode ping, l’API renvoie l’ID du partenaire ainsi que la date et l’heure actuelles :
{ "stamp": 1495544024, "time": "2017-05-23 14:53:44", "partnerId": 300000, "requestId": "1495544024.0084.8420" }
Réponses d’erreur
En cas d’erreur, le serveur renvoie un code HTTP autre que 200 et le corps de la réponse indique le code d’erreur et sa description.
Par exemple, pour une requête dont l’authentification est incorrecte :
{ "error": { "code": "C507", "error": "Authentication failed" }, "requestId": "1495544185.1615.8422" }
Si vous rencontrez un problème avec l’API ou si vous devez retrouver une requête spécifique à l’aide du requestId,
vous pouvez écrire à
affiliate@wedos.com.