Saltar al contenido principal

Formato de respuesta

Todas las respuestas de la API de Wappfy siguen un formato de envoltura consistente.

Respuestas exitosas

Toda respuesta exitosa esta envuelta en un objeto estandar:
{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
CampoTipoDescripcion
successbooleanSiempre true en respuestas exitosas
dataobject | arrayEl contenido de la respuesta
meta.requestIdstringIdentificador unico de la solicitud para depuracion
meta.timestampstringMarca de tiempo en formato ISO 8601

Respuestas paginadas

Los endpoints que devuelven listas incluyen metadatos de paginacion:
{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  },
  "meta": {
    "requestId": "req_def456",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
Usa los parametros de consulta page y limit para controlar la paginacion:
GET /api/instances?page=2&limit=10

Respuestas de error

Las solicitudes fallidas devuelven un objeto de error:
{
  "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"
  }
}

Codigos de error comunes

Estado HTTPCodigoDescripcion
400VALIDATION_ERROREl cuerpo de la solicitud no paso la validacion
401UNAUTHORIZEDToken de autenticacion ausente o invalido
403FORBIDDENPermisos insuficientes
404NOT_FOUNDEl recurso no existe
409PLAN_LIMIT_REACHEDLimite de instancias de tu plan alcanzado
429RATE_LIMIT_EXCEEDEDDemasiadas solicitudes
500INTERNAL_ERRORError inesperado del servidor
El meta.requestId es util para solicitudes de soporte — incluyelo al contactar al equipo de soporte para una depuracion mas rapida.