Afin d'établir une communication entre votre application et Bictorys, il est nécessaire de disposer de votre clé secrète. Bictorys utilise la clé secrète de votre compte pour authentifier vos requêtes API.

📘

Note

Votre clé secrète doit être traitée comme une information confidentielle, car elle accorde un accès illimité pour effectuer des requêtes API auprès de Bictorys.

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": "Invalid authentication credentials"

"message": "No API key found in request"

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 developpeurs, repérez l'onglet Configuration des clés API et des webhooks. Generez et copiez la clé API souhaitée.

Les droits nécessaires pour les plugins e-commerce sont : checkoutWr et CustomerWr.

• 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:

• Validation des webhooks (consultez le guide de validation des webhooks pour plus de détails).
• Chiffrement (consultez le guide de chiffrement pour plus de détails).