Guide simplifié de l'intégration de l'API
Ce guide vous aidera à configurer et à gérer vos clés API, à comprendre les différents modes de fonctionnement et à utiliser les clés correctement pour des opérations sécurisées.
Comprendre les clés API
Les clés API sont les "mots de passe" qui permettent à votre application d'accéder à notre API. Gardez ces clés privées pour préserver la sécurité de vos transactions. Vous pouvez gérer ces clés à partir de votre tableau de bord. Notez que le partage de ces clés dans des lieux publics tels que GitHub ou dans le code côté client n'est pas recommandé en raison des risques de sécurité.
Obtenir les clés d'API
Vous pouvez trouver vos clés d'API en vous connectant à votre compte et en allant dans le tableau de bord. Si vous avez des difficultés à y accéder, contactez le propriétaire de votre compte. Il se peut qu'il doive vous accorder des autorisations supplémentaires.
Types de clés API
Il existe quatre clés API que nous vous fournissons :
- Clé secrète en mode test : Pour effectuer des appels API côté serveur en mode test.
- Clé publiable en mode test : Pour tester le code côté client dans les applications.
- Clé secrète du mode Live : Pour effectuer des appels API côté serveur en mode réel.
- Clé publiable en mode réel : Pour le code côté client dans les applications une fois qu'elles sont en ligne.
Modes de fonctionnement
Notre API fonctionne selon deux modes : le mode test et le mode réel.
- Mode test : Utilisez ce mode lorsque vous êtes encore en train de développer votre application. Il simule les interactions de l'API
mais ne traite pas les paiements réels.
- Mode réel : Utilisez ce mode lorsque votre application est prête à traiter de vraies transactions et à accepter de vrais paiements.
Comment utiliser vos clés API
Selon le mode dans lequel vous vous trouvez (test ou réel), utilisez les clés correspondantes.
- Clés secrètes : Utilisez-les pour les appels API côté serveur. Protégez ces clés ; ne les exposez pas publiquement.
- Clés publiables : Elles peuvent être incluses dans le code côté client de votre application. Elles sont utilisées pour collecter
les informations de paiement en toute sécurité.
Sécurisez vos clés d'API
Votre clé API secrète peut effectuer n'importe quelle transaction en votre nom. Pour la sécuriser :
- Limitez l'accès aux personnes qui en ont réellement besoin.
- Ne la laissez pas dans les systèmes de contrôle de version.
- Utilisez un gestionnaire de mots de passe ou un service de gestion des secrets pour la stocker.
- N'incluez pas votre clé d'API secrète dans des applications mobiles ou dans d'autres endroits où elle peut être extraite.
POSTCréation d'un compte
Pour intégrer un nouvel utilisateur à la plateforme Digifar.
L'utilisateur de l'API doit fournir :
- Un email
- Un mot de passe.
| Paramètre de la demande |
Exigée
| Description |
| email |
Oui |
Adresse e-mail |
| mot de passe |
Oui |
Mot de passe de l'utilisateur de l'API |
| confirmerMotdepasse |
Oui |
Confirmer le mot de passe |
Exemple :
http:// {baseURL}/api/account/register
email":"test@account.com"
"password":"xxxxxxxxxx"
"confirmPassword":"xxxxxxxxxx"
Réponse
| Paramètre de la demande |
Signification |
Description |
| 200 |
Réussite |
Utilisateur créé avec succès |
POSTCréation d'un Token d'accès
Pour obtenir un jeton d'accès, vous devez d'abord obtenir votre nom d'utilisateur et votre secret
client auprès de Digifar pour le mode LIVE ou TEST.
| Paramètre de la demande |
Exigée
| Description |
| Nom d'utilisateur |
Oui |
Id client de votre compte |
| mot de passe |
Oui |
Code secret du client de votre compte |
| Typedesubvention |
Oui |
Le type d'accès spécifié. Par exemple, le mot de passe |
Exemple :
"nom d'utilisateur":"test@account.com"
"mot de passe":"xxxxxxxxxx"
"typedesubvention":"mot de passe"
Transmettre la demande en utilisant l'option x-www-form-urlencoded dans le corps de la demande.
Réponse Json
{
"access_token": "GO7PpMH6pUSmGocV8g7KOlomAJ86f9vfEh74ZVP2x8OTcbk6eb
lGd3bPofM4xVGyhm0W9FbsDU_1eJ92A6wy2U9OQCow4tubISgKnJqwxVcuYYsUyQ9Wr
Ek8YJ1RRbXte_0iaQJBYX9e0GCkRSucETqvmxrvbWCQQ8bVebckKs0FPVPe74NOQK5i
Kn5Ax43B7LvSfC_KOJaPkDvhUYGQ9Wgi7IWtaHoQsN7xKwW78jyef9StRWRZfyRnNjO
9oC6G9f0euGnTaHCa97wc2K55RVoqr9_CUPJgkKQruVQnY_OwZHfrwAP6kmmHuVsyH2
zjT2QI7TCWjMosDsBWFkW4x3TqenDuAQi9olNkaxpMTgU4NvvQbquVGYmvDHgaNcB6Q
kXL-5oY44zVZgJyBRWpFfhHwRtYK02QPteuDVOtFJZXeLjqPJrRlCCBvkeQjANZmUs7
CjuCt31HUjCo1VP2FlC3otD0-sYbs_FHF6YBCQw",
"token_type": "bearer",
"expires_in": 1209599,
"userName": "test@gmail.com",
".issued": "Tue, 20 Feb 2024 12:49:22 GMT",
".expires": "Tue, 05 Mar 2024 12:49:22 GMT"
}