Premiers Pas avec l'API Diool | Introduction
Notre API RESTful vous offre la possibilité d'intégrer votre site web ou votre application avec l'API Diool et de commencer à collecter des paiements via mobile money au Cameroun.
L'API Diool vous permettra de :
Collecter des paiements numériques de tout payeur disposant d'un compte mobile money valide grâce à une demande d'API unique et ponctuelle appelée directement depuis votre propre application.
Transférer des fonds depuis un compte Diool vers tout bénéficiaire disposant d'un compte mobile money valide.
Vérifier le solde et les revenus de votre compte Diool.
Vérifier le statut d'une transaction.
Pour démarrer rapidement avec l'API Diool, vous pouvez suivre les étapes de ce guide. Nous vous recommandons d'utiliser notre environnement sandbox pour tester l'API, mais les mêmes étapes s'appliquent à notre environnement de production, avec quelques modifications au niveau des jetons d'API et de l'URL de l'environnement.
Que vous utilisiez l'environnement sandbox ou de production, les étapes principales seront les mêmes, comme suit :
Créez un compte avec Diool ici. Un abonnement Starter vous permet de faire des tests dans un environnement sandbox avec des réponses simulées, tandis qu'un abonnement Pro ou supérieur vous permet d'utiliser des jetons d'API en direct et de consulter l'historique des transactions de votre compte.
Référez-vous à la documentation de l'API pour comprendre son fonctionnement et savoir comment tester ou utiliser les principaux points d'accès.
Vous pouvez vous référer à ce guide pour apprendre comment générer des jetons d'API.
L'API Diool propose deux environnements afin de permettre aux développeurs de tester et de déployer leurs applications:
L'environnement SANDBOX où les développeurs peuvent effectuer des tests des différentes appels API et obtenir des réponses simulées du système.
L'environnement PROD où tous les appels agissent sur de vrais comptes utilisateurs Diool et bénéficiaires.
L'environnement est sélectionné en définissant le paramètre ENVIRONMENT_URL sur l'une des deux valeurs possibles:
SANDBOX: https://sandboxcore.diool.com/core/dioolapi/v1/
PROD: https://core.diool.com/core/dioolapi/v1/
L'autorisation pour l'API Diool se fait via un jeton d'accès (Bearer Token). Nous avons préparé un guide utile qui explique comment générer les jetons d'accès pour l'API Diool.
Si vous pensez que vos clés ont pu être compromises (par exemple, si vous les avez accidentellement incluses dans Git), vous devriez immédiatement les révoquer et en générer de nouvelles en utilisant le bouton Générer un jeton API dans la page Paramètres > API de votre tableau de bord.
Nous fournissons des instructions de test ainsi que des exemples d'appels API dans notre documentation API. Dans ce guide, nous allons vous proposer une méthode supplémentaire pour tester les points d'accès en utilisant Postman. N'hésitez pas à créer un compte gratuit sur Postman pour tester, ou utilisez tout autre outil de test d'API avec lequel vous vous sentez à l'aise.
Les opérations dans l'environnement SANDBOX n'ont aucun impact financier sur les comptes Diool réels ou les comptes bénéficiaires.
L'environnement SANDBOX vous permet de tester avec plusieurs fournisseurs (MTN, Orange), chaque opération donnant une réponse fixe indépendamment des détails de l'opération.
Pour le fournisseur MTN, toutes les appels API répondent soit comme réussis (Code de réponse : 0) ou nécessitant une confirmation (Code de réponse : 27).
Pour le fournisseur Orange, toutes les appels API renvoient une réponse d'échec (Code de réponse : 20).
Pour l'environnement PROD, vous pouvez trouver les différents codes de réponse et leurs significations dans la section Codes de Réponse de la documentation API. Voir également ci-dessous.
L'API Diool utilise un code pour identifier le Fournisseur dans une demande. Voici les Fournisseurs actuellement disponibles et leurs codes correspondants:
MTN : 62401
Orange : 62402
Nexttel : 62404
Express Union : EUMM
Si vous testez avec Postman, vous devriez enregistrer votre jeton d'API Diool dans l'onglet Authorization avec un Type de Bearer Token comme indiqué ci-dessous pour toutes vos demandes. L'en-tête d'autorisation sera automatiquement généré lorsque vous enverrez les demandes. En savoir plus sur l'autorisation.
Si ce n'est pas déjà configuré, vous devriez définir le Content-Type sur application/json dans l'onglet Headers comme illustré ci-dessous. Vous pouvez ignorer les autres paramètres d'en-tête.
Pour les points d'accès où vous devez transmettre des paramètres avec vos demandes, vous pouvez les ajouter dans l'onglet Body au format JSON (raw > JSON) comme illustré ci-dessous.
Maintenant que nous avons abordé certains des points communs à tous les points d'accès, examinons comment utiliser chacun d'entre eux.
Il y a quatre principaux points d'accès que nous allons tester. Suivez les liens ci-dessous pour les étapes pour chacun des points d'accès.
Point d'accès de Paiement /payment : Ce point d'accès exécute une demande de paiement à un payeur identifié par un numéro de compte de mobile money.
Point d'accès de Transfert /transfer : Ce point d'accès exécute une demande de transfert d'argent à un bénéficiaire identifié par un compte de mobile money.
Point d'accès de Solde /balance : Ce point d'accès exécute une demande pour récupérer le solde associé à un compte utilisateur Diool.
Point d'accès de Statut de Transaction /status : Ce point d'accès exécute une requête pour obtenir le statut d'une transaction spécifique (paiement, transfert, etc.).
Vous utilisez déjà ou testez l'API et avez besoin d'aide?
Libre-service: Consultez la FAQ.
Vous avez une question..? Discutez avec nous instantanément via le chat en direct sur notre centre d'aide.
Complètement bloqué..? Envoyez-nous un e-mail à helpdesk@diool.com et nous vous répondrons dès que possible.
L'API Diool vous permettra de :
Collecter des paiements numériques de tout payeur disposant d'un compte mobile money valide grâce à une demande d'API unique et ponctuelle appelée directement depuis votre propre application.
Transférer des fonds depuis un compte Diool vers tout bénéficiaire disposant d'un compte mobile money valide.
Vérifier le solde et les revenus de votre compte Diool.
Vérifier le statut d'une transaction.
Pour démarrer rapidement avec l'API Diool, vous pouvez suivre les étapes de ce guide. Nous vous recommandons d'utiliser notre environnement sandbox pour tester l'API, mais les mêmes étapes s'appliquent à notre environnement de production, avec quelques modifications au niveau des jetons d'API et de l'URL de l'environnement.
Que vous utilisiez l'environnement sandbox ou de production, les étapes principales seront les mêmes, comme suit :
Créez un compte avec Diool ici. Un abonnement Starter vous permet de faire des tests dans un environnement sandbox avec des réponses simulées, tandis qu'un abonnement Pro ou supérieur vous permet d'utiliser des jetons d'API en direct et de consulter l'historique des transactions de votre compte.
Référez-vous à la documentation de l'API pour comprendre son fonctionnement et savoir comment tester ou utiliser les principaux points d'accès.
Vous pouvez vous référer à ce guide pour apprendre comment générer des jetons d'API.
Environnements de Test et de Production
L'API Diool propose deux environnements afin de permettre aux développeurs de tester et de déployer leurs applications:
L'environnement SANDBOX où les développeurs peuvent effectuer des tests des différentes appels API et obtenir des réponses simulées du système.
L'environnement PROD où tous les appels agissent sur de vrais comptes utilisateurs Diool et bénéficiaires.
L'environnement est sélectionné en définissant le paramètre ENVIRONMENT_URL sur l'une des deux valeurs possibles:
SANDBOX: https://sandboxcore.diool.com/core/dioolapi/v1/
PROD: https://core.diool.com/core/dioolapi/v1/
Authentification
L'autorisation pour l'API Diool se fait via un jeton d'accès (Bearer Token). Nous avons préparé un guide utile qui explique comment générer les jetons d'accès pour l'API Diool.
Si vous pensez que vos clés ont pu être compromises (par exemple, si vous les avez accidentellement incluses dans Git), vous devriez immédiatement les révoquer et en générer de nouvelles en utilisant le bouton Générer un jeton API dans la page Paramètres > API de votre tableau de bord.
Tester les points d'accès de l'API
Nous fournissons des instructions de test ainsi que des exemples d'appels API dans notre documentation API. Dans ce guide, nous allons vous proposer une méthode supplémentaire pour tester les points d'accès en utilisant Postman. N'hésitez pas à créer un compte gratuit sur Postman pour tester, ou utilisez tout autre outil de test d'API avec lequel vous vous sentez à l'aise.
Les opérations dans l'environnement SANDBOX n'ont aucun impact financier sur les comptes Diool réels ou les comptes bénéficiaires.
L'environnement SANDBOX vous permet de tester avec plusieurs fournisseurs (MTN, Orange), chaque opération donnant une réponse fixe indépendamment des détails de l'opération.
Pour le fournisseur MTN, toutes les appels API répondent soit comme réussis (Code de réponse : 0) ou nécessitant une confirmation (Code de réponse : 27).
Pour le fournisseur Orange, toutes les appels API renvoient une réponse d'échec (Code de réponse : 20).
Pour l'environnement PROD, vous pouvez trouver les différents codes de réponse et leurs significations dans la section Codes de Réponse de la documentation API. Voir également ci-dessous.
Identifiants de Fournisseur
L'API Diool utilise un code pour identifier le Fournisseur dans une demande. Voici les Fournisseurs actuellement disponibles et leurs codes correspondants:
MTN : 62401
Orange : 62402
Nexttel : 62404
Express Union : EUMM
Paramètres Généraux
Si vous testez avec Postman, vous devriez enregistrer votre jeton d'API Diool dans l'onglet Authorization avec un Type de Bearer Token comme indiqué ci-dessous pour toutes vos demandes. L'en-tête d'autorisation sera automatiquement généré lorsque vous enverrez les demandes. En savoir plus sur l'autorisation.
Si ce n'est pas déjà configuré, vous devriez définir le Content-Type sur application/json dans l'onglet Headers comme illustré ci-dessous. Vous pouvez ignorer les autres paramètres d'en-tête.
Pour les points d'accès où vous devez transmettre des paramètres avec vos demandes, vous pouvez les ajouter dans l'onglet Body au format JSON (raw > JSON) comme illustré ci-dessous.
Maintenant que nous avons abordé certains des points communs à tous les points d'accès, examinons comment utiliser chacun d'entre eux.
Points d'accès de l'API
Il y a quatre principaux points d'accès que nous allons tester. Suivez les liens ci-dessous pour les étapes pour chacun des points d'accès.
Point d'accès de Paiement /payment : Ce point d'accès exécute une demande de paiement à un payeur identifié par un numéro de compte de mobile money.
Point d'accès de Transfert /transfer : Ce point d'accès exécute une demande de transfert d'argent à un bénéficiaire identifié par un compte de mobile money.
Point d'accès de Solde /balance : Ce point d'accès exécute une demande pour récupérer le solde associé à un compte utilisateur Diool.
Point d'accès de Statut de Transaction /status : Ce point d'accès exécute une requête pour obtenir le statut d'une transaction spécifique (paiement, transfert, etc.).
Besoin d'aide?
Vous utilisez déjà ou testez l'API et avez besoin d'aide?
Libre-service: Consultez la FAQ.
Vous avez une question..? Discutez avec nous instantanément via le chat en direct sur notre centre d'aide.
Complètement bloqué..? Envoyez-nous un e-mail à helpdesk@diool.com et nous vous répondrons dès que possible.
Mis à jour le : 24/08/2023
Merci !