Utiliser le Web Service

Chaque requête est composée des éléments suivants :
  • 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.payzen.eu/sdd.

Plusieurs ressources associées chacune à chemin (path) différent sont mises à disposition:

Action Méthode URl
Créer un mandat POST /mandates
Créer plusieurs mandats 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

( : ) dans le chemin indique une variable. Vous devez remplacer cette variable par une valeur réelle lorsque vous envoyez votre requête. Dans notre cas, vous devez remplacer :id par l'ID 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 S'identifier lors des échanges.

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"
 }

Tester le web service avec cURL

Cette partie suppose que vous ayez déjà installé cURL.

Pour utiliser cURL, tapez curl suivi de l'endpoint que vous souhaité interroger.

Exemple en appelant notre root-endpoint :

 curl https://secure.payzen.eu/sdd

En validant vous obtiendrez la réponse ci-dessous :

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html><head>
<title>404 Not Found</title>
</head><body>
<h1>Not Found</h1>
<p>The requested URL /sdd was not found on this server.</p>
<p>Additionally, a 404 Not Found
error was encountered while trying to use an ErrorDocument to handle the request.</p>
</body></html>

Pour obtenir la liste des mandats enregistrés sur votre boutique, modifiez la ligne de commande précédente en spécifiant le endpoint " /mandates " :

 curl https://secure.payzen.eu/sdd/mandates

Vous obtiendrez la réponse ci-dessous :

 {
  "name" : "ERROR",
  "message" : "Service error",
  "details" : "RESTEASY001545: No resource method found for GET, return 405 with Allow header"
 }

Vous obtenez cette réponse car vous ne vous êtes pas authentifié.

Découvrons maintenant comment s'authentifier en utilisant les en-têtes HTTP.