Bien démarrer
Authentification
Chaque appel à l'API est authentifié par une clé secrète, transmise dans un en-tête HTTP.
Votre clé d'API
Créez vos clés dans l'espace client, rubrique Configurer › Clés d'API. Une clé ressemble à ceci :
flr_live_Xb7kQ2mN9pR4tV6wY8zA1cE3gJ5lO0sU2iK4hF6d
Transmettez-la dans l'en-tête Authorization, précédée du mot Bearer :
curl https://flare.zola-labs.com/v1/account \
-H "Authorization: Bearer flr_live_VOTRE_CLE"
L'en-tête X-API-Key: flr_live_VOTRE_CLE est également accepté.
Attention : une clé donne accès à l'envoi de messages en votre nom et à votre solde. Elle ne doit jamais apparaître dans une application mobile, un site web côté navigateur ou un dépôt de code. Appelez Flare depuis votre serveur uniquement.
Gérer vos clés
- Une clé par application ou par environnement (production, préproduction) : en cas de fuite, vous ne révoquez que celle-là.
- La clé n'est affichée qu'une fois, à sa création. Flare n'en garde qu'une empreinte et ne peut pas vous la redonner : si vous la perdez, créez-en une autre.
- Révoquer une clé (bouton Révoquer) la désactive immédiatement et définitivement.
- La colonne Dernière utilisation vous indique si une clé sert encore.
Format des requêtes
- Toutes les routes sont sous
https://flare.zola-labs.com/v1. - Envoyez du JSON avec l'en-tête
Content-Type: application/json. - Les numéros de téléphone s'écrivent au format international, indicatif pays compris :
+237699001122. Les espaces, tirets et le préfixe00sont tolérés ; Flare renvoie toujours le numéro sous la forme+237699001122. - Les dates sont au format ISO 8601, en UTC.
- Les montants sont des entiers, en francs CFA.
Limite de requêtes
Chaque clé peut faire 120 requêtes par minute. Au-delà, l'API répond 429 avec le code rate_limited et un en-tête Retry-After qui indique, en secondes, quand réessayer.
Cette limite protège la plateforme ; elle est indépendante des limites propres aux codes OTP, décrites dans Codes OTP.
Erreurs d'authentification
| Code HTTP | Code d'erreur | Signification |
|---|---|---|
| 401 | missing_api_key |
Aucune clé dans la requête. |
| 401 | invalid_api_key |
Clé inconnue ou révoquée. |
| 403 | account_suspended |
Le compte est suspendu : contactez le support. |
Toutes les erreurs de l'API suivent le même format, décrit dans Erreurs.