Identifiants API

Prev Next

L'authentification à l'API Frisbii Billing and Pay s'effectue à l'aide d'une clé API privée, qui constitue un élément essentiel pour garantir un accès sécurisé à l'API.

Les clés API nécessaires à l'intégration de l'API, ainsi que le Checkout helper, peuvent être générées et gérées ici de manière simple. Le processus de génération de ces clés est conçu pour être convivial, permettant aux développeurs de créer facilement les identifiants nécessaires à leurs applications.

La clé API a pour objectif de valider la signature plutôt que de faire office de bearer token. Elle vérifie les requêtes Webhook grâce au chiffrement HMAC-SHA256.

Cliquez sur le bouton New situé dans le coin supérieur droit pour commencer à créer une clé API.

Configuration de l'accès à la clé API

Lors de la création de la clé API, vous pouvez configurer le type d'accès dont disposera la clé, afin de contrôler les actions qu'elle peut effectuer. Il s'agit d'une étape essentielle pour garantir que votre intégration API est sécurisée et adaptée à vos besoins spécifiques.

Lors de la génération d'une clé API, vous pouvez soit donner accès à l'ensemble de l'application en activant la clé API globale, soit donner accès à des actions spécifiques répertoriées ci-dessous

  • Afficher les clients, abonnements, factures, transactions

  • Modifier le client

  • Modifier les abonnements

  • Modifier les factures et transactions

  • Autoriser les remboursements

  • Paramètres du compte, plans, add-ons, remises, coupons, etc.

  • Afficher les versements

Les clés API sont visibles et peuvent être copiées pendant 5 secondes maximum au moment de leur création, ce qui représente une fenêtre de temps brève nécessitant une action rapide. Si vous manquez de la copier pendant ce délai, vous ne pourrez plus la revoir, ce qui peut s'avérer très gênant. Il est donc essentiel de veiller à copier la clé immédiatement après sa création.

Si vous ne le faites pas, vous devrez créer une nouvelle clé, ce qui implique de répéter le processus de génération. Pour lancer ce processus, il vous suffit de cliquer sur le bouton New situé en haut à droite de la page pour commencer à créer une nouvelle clé API. Cette action vous guidera à travers les étapes nécessaires pour obtenir une nouvelle clé que vous pourrez utiliser pour vos besoins d'intégration.