Démarrer
Authentification
Clés API live et test, en-tête Authorization, restriction par adresse IP et identifiant de requête.
Chaque requête porte une clé API créée dans l'espace client (Développeurs > Clés API), dans l'en-tête Authorization :
Authorization: Bearer lsk_test_xxxxxxxxxxxxxxxxClés live et clés de test#
| Préfixe | Usage | Effet |
|---|---|---|
lsk_live_… | Production | Les SMS partent réellement et consomment des crédits. |
lsk_test_… | Bac à sable | Fournisseur simulé : rien n'est envoyé, aucun crédit consommé. POST /otp/send renvoie le code (test_code). |
La clé n'est affichée qu'une fois, à sa création. Elle doit rester côté serveur : jamais dans une application mobile, un navigateur, un dépôt Git ou un journal. En cas de fuite, révoquez-la dans l'espace client.
Tester la clé#
GET /balance est l'appel le plus simple pour vérifier une clé :
curl "https://api.labyrinthe-rdc.com/api/public/v1/balance" \
-H "Authorization: Bearer lsk_test_xxxxxxxxxxxxxxxx"Erreurs d'authentification#
401 UNAUTHENTICATED: clé absente (« Clé API manquante. »), invalide ou révoquée.403 FORBIDDEN: la clé est restreinte à une liste d'adresses IP et l'appel vient d'une autre adresse.403 ACCOUNT_SUSPENDED: le compte est suspendu par la plateforme, toute l'API est fermée jusqu'à réactivation.
Restriction par adresse IP#
Une clé peut être limitée aux adresses IP de vos serveurs (réglage de la clé dans l'espace client). Recommandé en production.
URL de base#
https://api.labyrinthe-rdc.com/api/public/v1Tous les packages utilisent cette URL par défaut et acceptent la variable LABYRINTHE_BASE_URL pour la changer (ex. http://localhost:8000 en développement : /api/public/v1 est ajouté).
Identifiant de requête#
Chaque réponse, erreurs comprises, porte l'en-tête X-Request-Id, à communiquer au support. Un X-Request-Id envoyé avec la requête est réutilisé s'il compte 1 à 128 caractères parmi A-Z a-z 0-9 . _ : - ; sinon un UUID est généré.