/
Référence CLI & API
📘 Ressources générales API
Bienvenue dans la référence de l'API Esadax. Vous trouverez ici toutes les informations essentielles dont vous avez besoin pour interagir avec notre API, notamment comment vous authentifier, comprendre les statuts de réponse et résoudre les erreurs de validation.
Authentification
Toutes les requêtes API doivent être authentifiées à l'aide d'un jeton API. Cela se fait en ajoutant un en-tête Authorization à votre requête HTTP.
✅ Format d'en-tête
Authorization: Bearer XXX
Remplacez XXX par votre jeton API réel.
À propos des jetons API
- Les tokens API sont générés par compte utilisateur.
- Chaque jeton peut avoir des autorisations personnalisées pour limiter l'accès à des zones spécifiques de votre compte.
- Cela permet de sécuriser votre intégration en accordant uniquement l'accès nécessaire.
➡️ En savoir plus sur la gestion des tokens API
Réponse de l'API
Esadax utilise les principes RESTful et se conforme aux pratiques de réponse HTTP standard. Chaque réponse de l'API inclura un code d'état HTTP pertinent pour indiquer le succès ou l'échec de votre demande.
📊 Codes d'état HTTP
| Code | Nom : | Description : |
|---|---|---|
| 200 dollars | OK | La demande a été acceptée avec succès. |
| 201 | Création | La ressource a été créée avec succès. |
| 202 | Acceptée | La demande a été acceptée et le traitement se poursuit en arrière-plan. |
| 204 | Pas de contenu | La demande a été acceptée, mais il n'y a pas de contenu à renvoyer. |
| 400 dollars | Une mauvaise demande | Une erreur est survenue lors de votre demande. Vérifiez la configuration requise du point de terminaison et réessayez. |
| 401 | Non autorisé | Jeton API non valide. Lire la suite. |
| 403 | Interdit | L'action n'est pas autorisée pour ce jeton ou ce compte. Vérifiez les autorisations de jeton. |
| 404 | Page non trouvée | La ressource demandée n'existe pas. |
| 405 | Méthode non autorisée | La méthode HTTP utilisée n'est pas prise en charge pour ce point de terminaison. |
| 408 | Demande de délai d'attente | Il y a eu un temps mort de notre côté. Veuillez contacter le support. |
| 421 | Service non disponible | Ce site est actuellement en maintenance. Veuillez réessayer plus tard. |
| 422 | Entité non traitable | Erreur de validation dans votre demande. Vérifiez et réessayez. Lire la suite |
| 429 | Trop de demandes | Limite de débit dépassée. En savoir plus sur les limites de débit |
| 500 dollars | Erreur interne du serveur | Erreur de serveur inattendue. Veuillez contacter le support. |
| 502 | Une mauvaise passerelle | Problème de système temporaire. Veuillez contacter le support. |
| 503 | Service non disponible | Ce site est actuellement indisponible. Veuillez contacter le support. |
| 504 | Délai d'attente de passerelle | Il y a eu un délai d'attente sur notre système. Veuillez contacter le support. |
🔗 Vous trouverez plus d'informations sur les codes d'état HTTP sur Mozilla Developer Network.
Erreurs de validation
Les erreurs de validation (HTTP 422) se produisent lorsque votre charge utile de demande ne répond pas aux exigences d'un point de terminaison donné. Cela pourrait être dû à:
- Champs obligatoires manquants
- Formats de données non valides
- Paramètres incorrects
Vérifiez toujours la documentation du point de terminaison API pour vous assurer que le corps de votre requête correspond au format attendu.
