Référence API

• Informations complètes sur toutes les API prises en charge
• Exemples pour chaque requête API
• Description des paramètres obligatoires et facultatifs inclus dans la requête API
• Une console API que vous pouvez utiliser pour tester l’API; modifiez les paramètres dans les exemples et voyez comment l’API répond.
• Possibilité d’appeler le serveur fictif ou le serveur de production

Utilisez le menu de navigation de gauche pour trouver l’API que vous souhaitez (faites défiler vers le bas jusqu’à la section RÉFÉRENCE :

Sélectionnez le titre de l’API sur la page pour afficher un exemple de l’API. Une fenêtre s’ouvre à droite de la page pour afficher l’exemple, comme le montre l’illustration ci-dessous.

Pour configurer et tester l’exemple dans la fenêtre Console, sélectionnez le bouton Passer à la console.
Dans la fenêtre Console, vous pouvez mettre à jour le point de terminaison d’API, les paramètres, les en-têtes et le corps de la requête. Par exemple, vous pouvez mettre à jour le point de terminaison d’API avec l’identifiant de la commande ou de la transaction requise pour une demande de consultation ou inclure votre account_id, qui est nécessaire lors de l’utilisation de certains points de terminaison d’API.

Lorsque vous êtes prêt à tester votre exemple, vous pouvez passer de l’environnement de production à l’environnement de simulation.

• Serveur Production : il s’agit en fait d’appeler la ressource sur le système Test de Paysafe. Pour utiliser ce serveur, vous devez remplacer deux éléments de requête par les détails de votre propre test :

  • Dans l’onglet Paramètres URI, modifiez tous les paramètres requis pour le point de terminaison. Par exemple, de nombreuses requêtes API ont besoin d’une valeur pour account_id. Connectez-vous au Portail Paysafe; une fois connecté, choisissez Comptes, puis copiez le numéro de compte depuis la colonne Compte. Le numéro de compte est requis pour certains appels d’API et est inclus soit dans le point de terminaison d’API (p. ex. paiements par carte, 3D Secure et prélèvement automatique), soit dans le corps de la requête (p. ex. hébergé, extendedOptions). Notez que le compte de test par défaut ne fonctionnera que pour 3D Secure et les paiements par carte à l’aide de l’API Paiements par carte ou Paiements hébergés avec la devise par défaut. Vous devrez demander des comptes de test supplémentaires au service de soutien si vous avez besoin de devises supplémentaires ou pour d’autres modes de paiement tels que le prélèvement automatique ou les modes de paiement alternatifs.
    

  • Sur l’onglet En-têtes, remplacez le texte "YOUR-BASE64-ENCODED-API-KEY" avec la clé API encodée en Base64 de votre compte Paysafe Test.
• Serveur fictif : cet environnement renvoie simplement les valeurs fictives de la réponse de l’exemple, quels que soient les paramètres que vous fournissez. Vous n’avez pas besoin d’utiliser votre identifiant de compte test ou votre clé d’API Test pour cette requête.

Pour appeler la ressource API, cliquez sur Appeler la ressource. La réponse est affichée dans la fenêtre Console.

Voir l’exemple ci-dessous.

Votre clé API doit être incluse dans la plupart des requêtes API adressées à la plateforme de paiement Paysafe.

Il existe deux clés API

• Clé API serveur à serveur : il s’agit de la clé API par défaut utilisée par la plupart des appels. Cette clé API est utilisée pour les appels entre votre serveur marchand et les serveurs de Paysafe.
• Clé API à jeton à usage unique : cette clé est utilisée par les appareils des clients (téléphones mobiles ou navigateur d’un utilisateur) pour un nombre limité d’appels API.

Chaque clé API se présente sous deux formes :

• Forme standard composée de deux éléments : un nom d’utilisateur et un mot de passe.
• Forme encodée au format Base64, créée par la concaténation du nom d’utilisateur et du mot de passe, séparés par deux points (username:password), suivie du codage du résultat au format Base64. Voir la rubrique Authentification pour de plus amples renseignements.

Différents outils de test de l’API REST peuvent utiliser différentes formes de clés. De même, différentes SDK peuvent nécessiter l’une ou l’autre des formes.

1. Connectez-vous au Portail Paysafe et sélectionnez Paramètres > Clé API.
   Votre clé API est composée de votre nom d’utilisateur et de votre mot de passe.
2. Pour générer une version codée au format Base64 de votre clé API, sélectionnez le lien Afficher au format Base64.
   La version au format Base64 est affichée dans une fenêtre contextuelle.
3. Pour copier la clé codée, cliquez sur Copier.

La section Référence API fournit une fenêtre de console qui vous permet de tester les appels API à partir d’un navigateur Web.

Pour tester l’utilisation des authentifiants de votre propre compte, collez votre clé API encodée sur la chaîne YOUR-BASE-64-ENCODED API key dans l’en-tête Authorisation de la console d’API.