Démarrer

Format des réponses

Les réponses sont en JSON, encodé en UTF-8, de même que le corps des appels qui en envoient un (avec l'en-tête Content-Type: application/json). Deux exceptions, qui décrivent l'API elle-même : GET /v1/documentation.md renvoie du texte (Markdown), et GET /v1/openapi.json renvoie du JSON sans l'enveloppe data.

Un succès renvoie {"data": …, "meta": {"request_id": "…"}} : data porte le résultat (un objet ou une liste), meta les informations sur la réponse.

Une erreur renvoie toujours la forme suivante, avec ces six champs :

{
  "error": {
    "code": "missing_scope",
    "message": "Cette clé n'a pas la permission « export_customers » (« Exporter tout le fichier clients »).",
    "hint": "Le titulaire du compte peut ajouter cette permission à la clé dans les paramètres de son compte Wanapos, ou créer une nouvelle clé qui la porte. Les permissions de la clé actuelle sont listées par GET /v1/me.",
    "field": "export_customers",
    "details": [],
    "request_id": "3f9a1c0b7d2e4a61"
  }
}

code est un texte stable, à tester dans un programme. message dit ce qui ne va pas et hint comment corriger, tous deux en français. field nomme le paramètre, le champ ou la permission en cause (chaîne vide sinon). details est une liste, vide le plus souvent : quand plusieurs champs d'un envoi sont refusés, elle porte un objet par champ, de la forme {"field": "…", "message": "…"}.

Aucune valeur n'est jamais null : une information absente vaut une chaîne vide, 0, false ou une liste vide. Les dates sont au format ISO 8601. Les champs des données métier (clients, produits…) portent les noms utilisés dans Wanapos, en français, identiques à ceux des événements sortants : un objet reçu par un événement et le même objet lu par l'API ont la même forme.

Une question ? contact@wanapos.com