Documentation de l'API de gestion des annonces - Wanaboat.fr
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md
categories.md
classifieds.md
medias.md

README.md

API de gestion des annonces de Wanaboat.fr

Cette API utilise le style REST (via les méthodes HTTP) et sérialise les données au format JSON. L'authentification se fait au moyen du jeton d'API disponible sur la page de gestion du compte, si l'API a été activée pour ce compte (nous contacter pour cela).

Emettre une requête

L'URL de l'API est http://www.wanaboat.fr/api. Pour contruire l'URL de votre requête, il faut donc concaténer cette URL de base avec le chemin de la ressource désirée, et joindre votre clé d'API via le paramètre api_key. Illustration avec une valeur de clé imaginaire :

curl http://www.wanaboat.fr/api/classifieds.json?api_key=23fe87f5dbece67baafd5f6454b87a46dd498105

Codes de retour

L'API utilise au maximum les codes d'erreur HTTP. Voici une liste non exhaustive des codes utilisés :

  • 200 OK : OK, tout s'est bien passé
  • 201 Created : ressource créé avec succès
  • 401 Unauthorized : non autorisé (mauvaise clé d'API)
  • 422 Unprocessable entity : données non valides

Sections