ApiBundle fournit un ensemble de Rest API qui vous permettent d'aller rapidement et de construire vos applications puissantes sans perdre votre temps à réinventer la roue. Toutes nos API sont hautement sécurisées et fournies via HTTPS. Nos apis sont très intuitives et donc, tout développeur ou non peut facilement les utiliser.
ApiBundle utilise l'apikey pour authentifier chaque requête. Vous pouvez simplement la passer à travers les paramètres de votre requête GET.
Si ce n'est pas déjà fait, inscrivez-vous pour obtenir une clé gratuite avant d'aller plus loin, afin de pouvoir la tester facilement.
https://api.apibundle.io
Nous prenons le traitement des erreurs très au sérieux, c'est pourquoi nous avons dédié tout sujet à cela. Nous utilisons à la fois les codes d'état HTTP standard et les messages métiers pour indiquer le succès ou l'échec d'une requête. Les requêtes réussies recevront un code de réponse 200, tandis que les réponses avec un 40x ou 500 indiquent un échec.
Indépendament du code d'état HTTP, tout message d'erreur a pour réponse la structure suivante
| Champ | Type | Description |
|---|---|---|
| type | string |
Une chaîne de caractères qui indique le type ou la nature de l'erreur. Consultez la liste suivante pour obtenir une liste complète des types disponibles |
| message | string |
La description de ce qui a fait échouer la requête |
| subtype Optionnel | string |
Un type d'erreur plus précis |
| field Optionnel | string |
Le champ qui cause l'erreur |
Voici une liste de toutes les valeurs du champ "type" défini précédemment qui sont communes à toutes les APIs. Les valeurs particulières seront listées dans la page de l'API concernée.
| Type d'erreur | Code HTTP | Description |
|---|---|---|
| VALIDATION_ERROR | 400 | Cela se produit lorsque les champs de la demande ne sont pas corrects. En général, il contient également un champ subtype et un champ field qui donnent plus de détails sur le problème. |
| BAD_REQUEST | 400 | Une chaîne de caractères qui indique le type ou la nature de l'erreur. Consultez la liste suivante pour obtenir une liste complète des types disponibles |
| QUOTA_REACHED | 400 | Apparaissent lorsque vous avez atteint votre quota mensuel. Dans ce cas, vous devez renouveler vos crédits. Vous pouvez vous connecter et aller dans la section "Plans et crédits" du tableau de bord pour renouveler vos crédits. |
| INVALID_API_KEY | 401 | Lorsque la clé fournie n'est pas valide, ce qui signifie que nous ne la reconnaissons pas du tout. |
| API_KEY_NOT_FOUND | 401 | Comme son nom l'indique, cela se produit lorsque, par magie, vous oubliez de mettre votre clé api. |
| NOT_FOUND | 404 | Pour une route ou un service non trouvé |
| INTERNAL_ERROR | 500 | L'erreur big boss, elle indique une défaillance sur nos serveurs. Bien que ces erreurs soient rares, si vous en rencontrez une, vous pouvez nous contacter à l'adresse hello@apibundle.io et nous ferons rapidement le nécessaire pour résoudre le problème. |