Pour appeler nos APIs
Afin d'établir une communication entre votre application et Bictorys, il est nécessaire de disposer d'une clé d'API.
Chacun marchand dispose d'une clé d'API publique unique qui est utilisée pour appeler l'API charges.
Vous pouvez générer une clé d'API sécrete par application pour des opérations sensibles.
Bictorys utilise vos clés d'API de votre compte pour authentifier vos requêtes API.
Note
Chaque compte dispose d'API de test et d'API de production. Pour tester nos APIs, générer une clé de test depuis le portail marchand.
Note
Vos clés sécretes doivent être utilisées pour appeler nos APIs depuis votre serveur uniquement. Ne jamais partager la clé secréte.
La clé d'API publique est utilisée pour appeler nos APIs depuis un browser, elle n'est pas confidentielle.
curl --request POST \
--url 'https://api.test.bictorys.com/pay/v1/charges?payment_type=card' \
--header 'accept: application/json' \
--header 'content-type: application/json'
Si vous oubliez d'inclure votre clé lors de la création d'une requête API ou si vous fournissez une clé incorrecte, Bictorys répondra par un message d'erreur.
"message": "Wrong API key"
"message": "Missing API Key"
Obtenir vos clés API
Chaque compte est livré avec trois ensembles de clés API : la clé secrète utilisée pour effectuer des requêtes API, la clé publique qui identifie votre compte auprès de Bictorys, et la clé secrète de webhook qui est utilisée pour valider les webhooks. Toutes les clés API sont disponibles pour les modes Live et Test.
Pour obtenir vos clés API, suivez les instructions ci-dessous :
Etape 1
Connectez-vous à votre tableau de bord Bictorys et accédez à la section Developpeurs dans le menu latéral.
Etape 2
Sur la page des développeurs, repérez l'onglet Configuration des clés API et des webhooks. Genérez et copiez la clé API souhaitée.
Si vous voulez tester votre intégration passer d'abord en mode test en cliquant sur le bouton Test mode en haut à droite de votre tableau de bord, puis générez vos clés API de test. Les clés de productions de peuvent être utilisées sur notre portail développeur.
- Clé Publique
La clé publique est destinée uniquement à l'identification de votre compte auprès de Bictorys. Elle peut être en toute sécurité publiée dans des endroits tels que votre interface frontale ou votre application mobile. Il est possible d'en générer et d'en ajouter plusieurs autres en meme temps.
- Clé Privée
Il est crucial de maintenir votre clé secrète confidentielle, car elle accorde un accès illimité pour effectuer des requêtes API auprès de Bictorys.
Attention
Vous ne pourriez copier votre clé qu'une fois après l'avoir generée.
Webhooks
La clé de chiffrement peut être utilisée à des fins suivantes: