Passer des appels API
Avant de lancer votre premier appel à l’API, vous devrez disposer de tout ou partie des informations suivantes :
- Point de terminaison d’API : il s’agit de l’URL à laquelle vous envoyez votre requête, et son format dépend du type d’appel à l’API.
- Clé API : vous l’obtenez lorsque vous vous inscrivez pour un compte de test et que vous avez accès au Portail Paysafe, et devez l’inclure dans l’en-tête Authorization HTTPS de la plupart des requêtes d’API. Une fois connecté au Portail Paysafe, choisissez Settings > API Key et prenez note de votre clé API nom d’utilisateuret mot de passe; le mot de passe est également disponible au format codé en Base64.
- Numéro de compte : Certains appels d’API nécessitent un numéro de compte (Account ID), qui est inclus soit dans le point de terminaison d’API (p. ex. paiements par cartes, 3D Secure et prélèvement automatique), soit dans le corps de la requête (p. ex. Hosted, extendedOptions). Vous l’obtenez lorsque vous vous inscrivez pour un compte de test et que vous avez accès au Portail Paysafe; une fois connecté, choisissez Accounts et copiez ensuite le numéro de compte à partir de la colonne Account.
- Corps du message : il doit s’agir d’un JSON valide qui contient des objets JSON Paysafe valides, conformément au type de requête. Tous les appels API ne nécessitent pas un corps de message : par exemple, les requêtes GET ne nécessitent pas de corps de message.
- Identifiant de ressource : certains appels d’API nécessitent un identifiant de ressource dans le point de terminaison d’API, par exemple pour faire référence à une ressource qui a été créée lors d’une étape précédente.
Authentifiants d’un compte marchand
La plupart des appels à l’API, mais pas tous, exigent que vous indiquiez les authentifiants suivants :
| Authentifiants | Description | Exemple |
|---|---|---|
| Clé API | Votre clé API est offerte sous deux formes :
| Nom d’utilisateur – 66040-1001062690 Mot de passe – B-qa2-0-579b6aec-0-606c02147caae097f4392898ca08ae736e51d3093af388d90214528ac70b69c0359d3173d12480d07275ca54a7c7 |
| Numéro de compte bancaire | Il s’agit d’un numéro de compte unique, qui doit être inclus dans les requêtes API relatives aux paiements par carte, à 3D Secure, aux prélèvements automatiques et aux paiements alternatifs, mais qui n’est pas nécessaire pour les autres types de requêtes API. Différents comptes permettent différentes combinaisons de modes de paiement et de devises. | 1001062690 |
Les authentifiants de votre clé API (nom d’utilisateur et mot de passe) ne sont pas les mêmes que le nom d’utilisateur et le mot de passe que vous utilisez pour vous connecter au Portail Paysafe.
Chaque compte marchand dispose d’une clé API primaire unique (la clé API de serveur à serveur) utilisée pour la majorité des appels API.
Exemple
Le bout de code ci-dessous donne un exemple des authentifiants ci-dessus, incluses dans une requête cURL :
curl -X POST https://api.test.paysafe.com/customeridentification/v1/identityprofiles/ \
-u 66040-1001062690:B-qa2-0-579b6aec-0-606c02147caae097f4392898ca08ae736e51d3093af388d90214528ac70b69c0359d3173d12480d07275ca54a7c7 \
-H ’Content-Type: application/json’
Veuillez noter le format à inclure dans votre requête API selon l’exemple ci-dessus :
- 66040-1001062690 – la séquence de chiffres avant les deux points est votre nom d’utilisateur, à inclure dans le point de terminaison d’API.
- B-qa2-0-579b6aec-0-… – la séquence de chiffres après les deux points est votre mot de passe.
- Le nom d’utilisateur et le mot de passe doivent être codés en Base64 avant d’être inclus dans votre requête API. Vous pouvez le faire manuellement ou utiliser un outil pour l’automatiser. Pour plus d’informations, voir Authentification.
Dépannage des requêtes API
Vous trouverez ci-dessous une brève liste de questions susceptibles d’entraîner des problèmes.
- La requête n’est pas envoyée via HTTPS
- Les bons détails d’authentification (c’est-à-dire votre clé API) n’ont pas été inclus – une erreur fréquente consiste à ajouter des espaces avant ou après la clé API.
- Syntaxe JSON incorrecte dans le corps de votre requête
- Spécification d’une méthode HTTP incorrecte : pour la plupart des requêtes API, il s’agit de POST, tandis que les requêtes visant à extraire des informations de la plateforme Paysafe utilisent GET
- Oublier de modifier le numéro de compte (ID de compte) dans le point de terminaison pour qu’il corresponde à votre numéro de compte réel pour les appels qui l’exigent
- Utilisation d’un numéro de compte (ID de compte) qui ne correspond pas au type de requête
Pour plus de détails, voir la rubrique Dépannage.