Architecture de l’API REST
Les API qui respectent les contraintes d’architecture REST sont appelées API RESTful, ou simplement API REST. Les API REST basées sur le protocole HTTP de Paysafe sont définies en fonction des aspects suivants :
- Méthodes HTTP standard
Par exemple : GET, POST, DELETE et PUT - Point de terminaison d’API de base
Par exemple : https://api.test.paysafe.com/cardpayments/v1/accounts/account_id/auths - En-tête Content-Type JSON
Toutes les API REST de Paysafe utilisent Content-Type: application/json - En-tête d’autorisation d’accès de base
Le mot « Authorization » est suivi de la méthode d’autorisation, d’un espace, puis du nom d’utilisateur et du mot de passe de votre clé API au format Base64, séparés par deux points. Par exemple :
Authorization : Basic NTUwMzAtMTAwMTA2MjY5MDpCLXFhMi0wLTU3OWI2YWVjLTAtMzAyYzAyMTQ3Y
La plupart des outils de test d’API REST, comme Postman REST Client, peuvent créer cet en-tête automatiquement à partir du nom d’utilisateur et du mot de passe de votre clé API.
Pour de plus amples renseignements sur l’authentification d’accès de base, voir cet article de Wikipedia. - Corps de la requête
Le corps de la requête est composé de données utiles au format JSON.
Ce tableau décrit les méthodes HTTP prises en charge.
| Méthode HTTP | Description |
|---|---|
| GET | Demander des détails, tels que l’état d’une transaction, à la plateforme de paiement Paysafe. |
| POST | Envoyer des informations, telles qu’une demande d’autorisation ou de règlement, à la plateforme de paiement Paysafe. POST est également utilisé pour créer une nouvelle entité, par exemple l’adresse d’un client. |
| DELETE | Supprimer un enregistrement ou une transaction de la plateforme de paiement Paysafe. |
| PUT | Modifier ou mettre à jour un enregistrement existant sur la plateforme de paiement Paysafe. |
Tester les appels API à l’aide d’un client REST
Vous pouvez utiliser un client REST basé sur un navigateur, comme Postman ou le client REST avancé, pour envoyer des requêtes API de test à la plateforme Paysafe. L’illustration ci-dessous montre un exemple de configuration et d’envoi d’une requête à l’aide de Postman. Cette fonctionnalité vous permet d’essayer l’API à l’aide d’un navigateur Web standard sur votre PC local.
API REST : Postman Exemple 1
API REST : Postman Exemple 2
