Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.caurisflux.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Clés API

CaurisFlux utilise des clés API pour authentifier les requêtes. Vous trouverez vos clés dans le Dashboard.
Ne partagez jamais vos clés secrètes (sk_*). Elles donnent un accès complet à votre compte.

​
Types de clés

TypePréfixeUtilisation
Clé publiquepk_test_ / pk_live_Identification du marchand
Clé secrètesk_test_ / sk_live_Authentification côté serveur
Les deux clés sont nécessaires pour authentifier vos requêtes. Le format est clé_publique:clé_secrète.

​
Environnements

URL de base : https://sandbox-api.caurisflux.com/api/v1Préfixe des clés : pk_test_ / sk_test_
  • Aucune transaction réelle
  • Numéros de test disponibles
  • Idéal pour le développement

​
Méthodes d’authentification

Vous avez deux options pour authentifier vos requêtes :

​
Option 1 : Header X-API-Key (recommandé)

Ajoutez le header X-API-Key avec la valeur pk_xxx:sk_xxx.

​
Option 2 : Bearer Token

Ajoutez le header Authorization avec la valeur Bearer pk_xxx:sk_xxx.

​
Endpoints publics (sans authentification)

Certains endpoints ne nécessitent pas d’authentification :
EndpointDescription
GET /payments/providersListe des méthodes de paiement
GET /countries/activeListe des pays disponibles
GET /payments/public/status/:idStatut public d’un paiement
GET /payouts/reference/corridorsCorridors de payout
GET /payouts/reference/purposesMotifs de paiement
GET /healthÉtat de l’API

​
Bonnes pratiques

1

Variables d'environnement

Stockez vos clés dans des variables d’environnement, jamais dans le code source.
2

Fichier .gitignore

Ajoutez vos fichiers de configuration (.env, config.json) à .gitignore.
3

Clés différentes par environnement

Utilisez des clés différentes pour le développement, le staging et la production.

​
Rotation des clés

Pour des raisons de sécurité, vous pouvez régénérer vos clés à tout moment :
  1. Allez dans Dashboard > Paramètres > API
  2. Cliquez sur Régénérer à côté de la clé
  3. Mettez à jour votre application avec la nouvelle clé
L’ancienne clé reste active pendant 24h pour vous laisser le temps de migrer.

​
Erreurs d’authentification

CodeMessageSolution
401Non authentifiéVérifiez le format de vos clés
403Non autoriséVérifiez les permissions de votre compte