Passer au contenu principal

Format de reponse

Toutes les reponses de l’API Wappfy suivent un format d’enveloppe coherent.

Reponses de succes

Chaque reponse reussie est encapsulee dans un objet standard :
{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
ChampTypeDescription
successbooleanToujours true pour les reponses reussies
dataobject | arrayLe contenu de la reponse
meta.requestIdstringIdentifiant unique de la requete pour le debogage
meta.timestampstringHorodatage ISO 8601

Reponses paginées

Les endpoints qui retournent des listes incluent des metadonnees de pagination :
{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  },
  "meta": {
    "requestId": "req_def456",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
Utilisez les parametres de requete page et limit pour controler la pagination :
GET /api/instances?page=2&limit=10

Reponses d’erreur

Les requetes echouees retournent un objet d’erreur :
{
  "success": false,
  "error": {
    "code": "INSTANCE_NOT_FOUND",
    "message": "Instance with ID abc123 not found",
    "details": {}
  },
  "meta": {
    "requestId": "req_ghi789",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}

Codes d’erreur courants

Statut HTTPCodeDescription
400VALIDATION_ERRORLe corps de la requete n’a pas passe la validation
401UNAUTHORIZEDJeton d’authentification manquant ou invalide
403FORBIDDENPermissions insuffisantes
404NOT_FOUNDLa ressource n’existe pas
409PLAN_LIMIT_REACHEDLimite d’instances atteinte pour votre forfait
429RATE_LIMIT_EXCEEDEDTrop de requetes
500INTERNAL_ERRORErreur serveur inattendue
Le meta.requestId est utile pour les demandes de support — incluez-le lorsque vous contactez le support pour un debogage plus rapide.