Utiliser le Web Service
- une URL ( ou " endpoint ") demandée
- une méthode
- des en-têtes ( ou " headers")
- des données (ou " body")
Le point d'entrée (endpoint)
Le point d'entrée ( root-endpoint) de l'API est : https://secure.lyra.com/sdd.
Plusieurs ressources associées chacune à chemin ( path) différent sont mises à disposition:
| Action | Méthode | URl |
|---|---|---|
| Importer un mandat existant | POST | /mandates |
| Importer plusieurs mandats existants | POST | /multimandates |
| Consulter les données d'un mandat | GET | /mandates/{id} |
| Télécharger un mandat | GET | /mandates/{id} |
| Mettre à jour un mandat | PUT | /mandates/{id} |
| Supprimer un mandat | DELETE | /mandates/{id} |
Remplacer {id} par l'identifiant du mandat que vous souhaitez utiliser.
La méthode
Chaque ressource est accessible via une méthode spécifique. Cette méthode traduit l'action que vous souhaitez réaliser (voir tableau ci-dessus).
- GET Cette requête est utilisée pour obtenir une ressource depuis le serveur.
- POST Cette requête est utilisée pour créer une nouvelle ressource.
- PUT Cette requête est utilisée pour mettre à jour une ressource.
- DELETE Cette requête est utilisée pour supprimer une ressource.
Les en-têtes
Les entêtes HTTP sont des couples de clé-valeurs séparés par " :".
Ils sont utilisés pour transmettre les données d'authentification et des informations sur le contenu de la requête.
Les en-têtes utilisés dans cette API sont décrits au chapitre Authentification.
Les données (ou "body")
Les données (aussi appelées "body" ou "message") contiennent les informations que vous souhaitez transmettre au serveur. Elles sont utilisées uniquement dans les requêtes POST et PUT.
Les données sont transmises, dans les requêtes et les réponses, au format JSON (Javascript Object Notation).
Dans ce format, chaque propriété et valeur sont encadrées par des doubles quotes :
{
"propriété1" : "valeur1",
"propriété2" : "valeur2"
}