Pagination
Dans le cas où une requête API GET renvoie plusieurs résultats, Paysafe renvoie les 10 premiers enregistrements par défaut et utilise les liens HATEOAS pour permettre la navigation dans les pages. En plus du comportement par défaut, il est également possible de contrôler le nombre de résultats et le point de départ en passant les paramètres de requête comme suit :
| Nom | Description |
|---|---|
| limit | Il s’agit du nombre total d’enregistrements à renvoyer. Max = 50. Par défaut = 10. |
| offset | C’est la position de départ, où 0 est le premier enregistrement. Par défaut = 0. |
| startDate | Il s’agit de la date de début au format UTC. Par défaut = 30 jours avant endDate (date de fin). |
| endDate | Il s’agit de la date de fin au format UTC. Par défaut = date et heure actuelles. |
HATEOAS
L’API de gestion des comptes utilise une structure de point de terminaison RESTful et s’appuie sur les verbes HTTP (GET, PUT, POST, DELETE) pour déterminer l’action que vous tentez d’effectuer sur une ressource spécifique.
Chaque réponse à un appel API comprend un tableau de liens HATEOAS (Hypermedia as the Engine of Application State). Ces liens peuvent être utilisés pour intégrer des flux ultérieurs et fournissent généralement des informations sur ce que vous pouvez faire par la suite. En outre, ces liens peuvent être utilisés pour renvoyer à d’autres ressources liées à l’objet de réponse actuel.
Grâce à ces liens, vous n’avez plus besoin de coder en dur votre intégration pour appeler des URL de point de terminaison spécifiques afin d’utiliser notre API; vous pouvez plutôt utiliser l’URL renvoyée dans le but spécifique défini par la définition rel.
Structure de lien HATEOAS
Élément | Description |
|---|---|
| rel | Relation de lien qui décrit comment ce lien est lié à l’appel précédent. Les exemples incluent « self » (obtenir les détails de l’appel en cours), « next » (naviguer vers l’ensemble de ressources suivant) ou un appel connexe. |
| href | URL du lien HATEOAS correspondant que vous pouvez utiliser pour les appels ultérieurs. |
Vous trouverez ci-dessous des exemples de liens HATEOAS provenant d’une réponse API qui renvoie un ensemble de sous-comptes associés à un compte marchand spécifique. Des liens sont fournis pour naviguer dans l’ensemble des ressources.
GET https://api.paysafe.com/accountmanagement/v1/accounts/{ACCOUNT_ID}/subaccounts&limit=10&offset=10
...result set
"links": [{
"rel": "self",
"href": "https://api.test.paysafe.com/accountmanagement/v1/accounts/{ACCOUNT_ID}/subaccounts&limit=10&offset=10"
}, {
"rel": "prev",
"href": "https://api.test.paysafe.com/accountmanagement/v1/accounts/{ACCOUNT_ID}/subaccounts&limit=10&offset=0"
}, {
"rel": "next",
"href": "https://api.test.paysafe.com/accountmanagement/v1/accounts/{ACCOUNT_ID}/subaccounts&limit=10&offset=20"
}]