Authentification
Gérez les clés et les permissions de votre intégration.
Utiliser votre clé API
Chaque requête vers une ressource agence doit inclure cet en-tête :
Authorization: Bearer VOTRE_CLE_ESIMYEnvoyez les corps de requête en JSON avec Content-Type: application/json. L’API publique est prévue pour des appels serveur à serveur.
Permissions disponibles
| Permission | Accès |
|---|---|
catalog:read | Consulter le catalogue des forfaits. |
orders:write | Créer les devis et les commandes. |
orders:read | Lire les commandes, les QR codes et la consommation. |
wallet:read | Lire le solde, les mouvements et les recharges. |
Attribuez à chaque clé uniquement les permissions nécessaires. Créez des clés séparées pour vos différentes intégrations.
Créer et révoquer une clé
Ouvrez l’espace agence puis « Clés API ».
Choisissez « Créer une clé », indiquez un nom et sélectionnez ses permissions.
Copiez immédiatement la clé : sa valeur complète n’est affichée qu’une fois.
En cas de perte ou de fuite, révoquez la clé et créez-en une nouvelle. Les prochains appels avec l’ancienne clé seront refusés.
Les clés API ne peuvent pas gérer d’autres clés ni lancer une recharge B-PAY. Ces opérations restent réservées au portail authentifié.
Comprendre les refus d’accès
| HTTP | Cause |
|---|---|
| 401 | Clé absente, invalide ou révoquée. |
| 403 | Permission manquante ou agence suspendue. |
| 404 | Ressource inexistante ou appartenant à une autre agence. |
{
"error": {
"code": "scope_required",
"message": "Cette clé ne dispose pas de la permission requise."
}
}