Vai al contenuto principale

Formato delle risposte

Tutte le risposte dell’API Wappfy seguono un formato envelope coerente.

Risposte di successo

Ogni risposta di successo e racchiusa in un oggetto standard:
{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
CampoTipoDescrizione
successbooleanSempre true per le risposte di successo
dataobject | arrayIl payload della risposta
meta.requestIdstringIdentificatore univoco della richiesta per il debug
meta.timestampstringTimestamp in formato ISO 8601

Risposte paginate

Gli endpoint che restituiscono liste includono metadati di paginazione:
{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  },
  "meta": {
    "requestId": "req_def456",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
Usa i parametri query page e limit per controllare la paginazione:
GET /api/instances?page=2&limit=10

Risposte di errore

Le richieste fallite restituiscono un oggetto errore:
{
  "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"
  }
}

Codici di errore comuni

Stato HTTPCodiceDescrizione
400VALIDATION_ERRORIl corpo della richiesta non ha superato la validazione
401UNAUTHORIZEDToken di autenticazione mancante o non valido
403FORBIDDENPermessi insufficienti
404NOT_FOUNDLa risorsa non esiste
409PLAN_LIMIT_REACHEDLimite di istanze raggiunto per il tuo piano
429RATE_LIMIT_EXCEEDEDTroppe richieste
500INTERNAL_ERRORErrore interno del server
Il campo meta.requestId e utile per le richieste di supporto — includilo quando contatti l’assistenza per un debug piu rapido.