Clés API

Aperçu

Nous authentifions vos requêtes API en utilisant la clé API - une combinaison unique de symboles associée à votre compte. Si une requête n'inclut pas de clé valide, Payment Gateway retourne une erreur de requête invalide. Si une requête inclut une clé supprimée ou expirée, Payment Gateway retourne une erreur d'authentification.

La clé API est transmise dans l'en-tête X-Api-Key d'une requête API :

curl -X GET "https://dev.bpcbt.com/api2/sessions/test_aksdhauedqiuwehdiqwbdq" \
-H "X-Api-Key: 6HUXQFbeomV1zf5i8cgm5W8KfncENVEa5uh8RngB" \
-H "X-Version: 2023-10-31" \

Vous pouvez générer autant de clés API que nécessaire. Par exemple, votre entreprise peut exiger une rotation annuelle des clés. Pour changer la clé API en toute sécurité, nous vous recommandons d'utiliser l'approche suivante :

1. Lorsque vous allez changer votre clé API, générez d'abord la nouvelle clé API.
2. Prenez en charge deux clés API : 1) l'ancienne, 2) la nouvelle que vous venez de générer.
3. Utilisez la nouvelle clé API dans les requêtes API pour vous assurer qu'elles sont correctement authentifiées.
4. Supprimez l'ancienne clé API.

Vous pouvez utiliser Merchant Portal pour générer ou supprimer des clés API. Voir les détails ci-dessous.

Génération d'une clé API

Pour générer une clé API :

1. Connectez-vous à Merchant Portal
2. Allez dans la section Clés API.

3. Cliquez sur Générer une clé API.

   

4. Dans la fenêtre ouverte, saisissez le nom de la clé et cliquez sur Générer.

   

5. La clé API générée est affichée sur la page Clés API. Vous ne pouvez copier cette clé que dans un délai de quelques minutes (le temps exact restant est affiché sous la valeur de la clé API). Après cette période de temps, la clé sera masquée pour toujours : seuls les 3 premiers et les 3 derniers symboles seront affichés.

   

Suppression d'une clé API

Pour supprimer une clé API :

1. Connectez-vous à Merchant Portal
2. Allez dans la section Clés API.

3. Cliquez sur le bouton de suppression près de la clé API que vous voulez supprimer.

   

4. La fenêtre de confirmation s'ouvre. Pour confirmer la suppression, saisissez votre mot de passe que vous utilisez pour vous connecter à Merchant Portal. Puis cliquez sur Supprimer.

   

   Après la confirmation, la clé API est définitivement supprimée.