Clés API et webhooks

Les API permettent à différentes applications ou systèmes de communiquer et de partager des données efficacement. Dans notre cas, les API de Paystack permettent à votre site web ou application mobile de communiquer et de partager des données avec le serveur de Paystack.

Parce que les API permettent à notre serveur de partager des données avec votre site web ou application mobile lorsque vous effectuez une demande, nous devons pouvoir confirmer que c'est bien vous qui effectuez la demande depuis votre site. C'est là que les clés API entrent en jeu. Lorsque votre site envoie ou demande des données depuis les serveurs de Paystack, il doit envoyer les données avec les clés API de votre tableau de bord. Si les clés API ne sont pas incluses, la demande sera refusée.

Lorsque vous vous inscrivez sur Paystack, nous vous encourageons à tester notre plateforme pour bien comprendre le flux de paiements avant de commencer à accepter des paiements réels. C'est pourquoi nous avons le Mode Test disponible. Vous pouvez effectuer des transactions en utilisant nos informations de paiement test en Mode Test.

Pour obtenir vos clés API de test, allez sur la page des paramètres de votre tableau de bord et cliquez sur l'onglet Clés API et Webhooks pour obtenir vos clés API de test. Faites défiler jusqu'à la section "Configuration de l'API - Mode Test", et vous trouverez votre Clé secrète de test et votre Clé publique de test comme indiqué ci-dessous :

Une fois que vous avez terminé les tests et êtes satisfait de votre intégration, vous aurez besoin de vos clés API en mode actif pour pouvoir recevoir de l'argent réel de vos clients.

Pour afficher vos clés secrètes, cliquez sur l'icône en forme d'œil à côté de celle-ci. Il vous sera demandé de remplir votre mot de passe de compte, après quoi vous verrez la clé.

Pour obtenir vos clés API en mode actif, allez dans les paramètres de votre tableau de bord et cliquez sur l'onglet Clés API et Webhooks. Faites défiler jusqu'à la section "Configuration de l'API - Mode Live", ici vous trouverez votre Clé secrète en mode actif et votre Clé publique en mode actif comme indiqué ci-dessous :

Vous ne pouvez basculer en mode actif que si votre compte a été activé. Découvrez comment activer votre entreprise ici.

Si vous avez besoin de générer de nouvelles clés API pour votre entreprise, vous pouvez le faire depuis votre tableau de bord en quelques clics. Cela vous permet de désactiver votre clé secrète et d'en obtenir une nouvelle instantanément. Cela peut être particulièrement utile si votre clé secrète a été partagée accidentellement ou compromise de toute autre manière.

Une fois que vous avez généré une nouvelle clé secrète, vous ne pourrez pas traiter de transactions tant que vous n'aurez pas mis à jour votre clé secrète sur votre site web ou serveur. Seuls les administrateurs et le propriétaire principal de l'entreprise peuvent générer de nouvelles clés API. Chaque modification apportée à vos clés API sera enregistrée dans vos journaux d'audit.

Vous pouvez suivre ces étapes pour générer de nouvelles clés API :

1. Sur votre tableau de bord, allez dans la page des paramètres et cliquez sur l'onglet "Clés API et Webhooks".

2. Sous vos clés secrètes en mode réel et test, vous verrez un bouton intitulé "Générer une nouvelle clé secrète". Cliquez dessus.

3. Lorsque vous sélectionnez cela, vous pouvez choisir quand votre ancienne clé expire et fournir votre mot de passe de compte pour compléter le processus. Une fois que vous avez terminé, cliquez sur "Générer une nouvelle clé secrète". Nous désactiverons votre ancienne clé secrète en fonction du temps spécifié, mais vous recevrez vos nouvelles clés immédiatement.

L'URL de rappel est une adresse web où vous souhaitez que vos clients soient redirigés après qu'un paiement ait été effectué avec succès.

Cela peut être votre page de médias sociaux ou votre site web - vous pouvez même les rediriger pour vous envoyer un message sur WhatsApp. Si vous souhaitez configurer une URL de rappel, il vous suffit de coller le lien dans le champ approprié de l'URL de rappel.

Un Webhook est un lien sur votre serveur auquel Paystack envoie des informations pour les transactions réussies qui passent par votre compte.

Cela est important dans les cas où, par exemple, un client n'est pas redirigé vers votre URL de rappel après une transaction réussie. Dans ce cas, notre serveur envoie une notification à votre URL de webhook afin que vous puissiez fournir la valeur. Si vous souhaitez configurer des webhooks, il vous suffit de coller le lien sur votre serveur dans le champ approprié de l'URL de webhook.

Vous pouvez en savoir plus sur la configuration des webhooks ici.

Si vous utilisez l'un de nos outils hébergés Paystack pour collecter des paiements, vous n'avez pas besoin de configurer de clés en mode réel ou de webhooks car ils sont déjà intégrés dans les outils. Les outils hébergés par Paystack, tels que les factures et la vitrine, gèrent le processus de collecte des paiements pour vous et mettent automatiquement à jour vos enregistrements de paiement sur le tableau de bord.