Vue d’ensemble
Walkap API est un service Web qui met a disposition de celui qui a accès une API REST qui permet de gérer des transactions monétaires.
Ce document rassemble la documentation de l’API, les services qui sont proposés ainsi que la manière d’utiliser le service. Vous trouverez des exemples qui permettront d’appréhender facilement le service.
Les verbes HTTP
Walkap API adhère pleinement aux conventions standards HTTP et REST en ce qui concerne les verbes HTTP.
| Verbe | Définition |
|---|---|
|
Utilisé pour récupérer une ressource |
|
Utilisé pour créer une ressource |
|
Utilisé pour mettre à jour une ressource existante, y compris des mis à jour partielles |
|
Utilisé pour supprimer une ressource existante |
Code d’état HTTP
Walkap API adhère pleinement aux conventions standards HTTP et REST en ce qui concerne les codes d’état HTTP.
| Code d’état | Définition |
|---|---|
|
La requête a été executée avec succès |
|
Une nouvelle ressource a été crée avec succès. Les liens des ressources sont disponibles dans l’entête de la réponse. |
|
La mise à jour d’une ressource existante a été appliquée avec succès. |
|
La requête est malformée. Dans le corps de la réponse se trouve un description de l’erreur rencontrée. |
|
La ressource demandée n’existe pas |
Entêtes
Toutes les réponses ont les entêtes suivantes :
Erreurs
Chaque fois qu’une réponse avec erreur (code d’état> = 400) est renvoyée, le corps de la réponse contiendra un objet JSON Qui décrit le problème.
Hypermedia
Walkap API utilise l’hypermédia et les ressources incluent des liens vers d’autres ressources dans leur
réponses. Les réponses sont disponibles dans Hypertext Application
from resource to resource.
Language (HAL). Les liens peuvent être trouvés via la clé _links. Les utilisateurs de l’API ne devraient
pas créer d’URI eux-mêmes, mais ils devraient utiliser les liens décrits ci-dessus pour naviguer dans la ressource.