Saltar a contenido

Formato de respuestas

El API Gateway envuelve las respuestas exitosas en un objeto común para facilitar el parsing en cualquier lenguaje.

Respuesta exitosa

{
  "data": { },
  "meta": {
    "requestId": "af05b422-4b10-4f48-bed9-cc00a171bc4e",
    "timestamp": "2026-05-21T18:10:49.357844300Z",
    "latencyMs": 342,
    "cached": false,
    "version": "v1"
  }
}

Campo data

Contiene el resultado de la operación. Forma típica según el tipo de llamada:

Operación Contenido típico de data
GET por id Objeto de la entidad (producto, cliente, factura, …)
POST / PUT Identificador creado o actualizado, p. ej. { "id": 5609 }
DELETE Entero con registros afectados
GET ´por listado Objeto paginado: content, totalElements, number, size, …

Campo meta

Campo Descripción
requestId Identificador único de la petición
timestamp Marca de tiempo de la respuesta
latencyMs Tiempo de procesamiento en milisegundos
cached Indica si la respuesta se sirvió desde caché
version Versión del contrato API

Ejemplo — registro creado con respuesta exitosa

{
  "data": { "id": 5609 },
  "meta": {
    "requestId": "fb10d34d-8a85-4ed7-8689-367a641ff505",
    "timestamp": "2026-05-21T18:10:49.357844300Z",
    "latencyMs": 342,
    "cached": false,
    "version": "v1"
  }
}

Respuestas paginadas

El API Gateway envuelve para los GET respuestas paginadas, para evitar saturación del servicio.

{
  data {
  "page": 0,
  "size": 20
  }
}

Page size

Se pueden solicitar hasta un máximo de 100 elementos por página, predeterminadamente son 20.

Peticiones

  • Envíe el cuerpo en JSON (Content-Type: application/json) salvo que la ruta documente otro formato.
  • Los parámetros de ruta y query se definen por endpoint en la sección Referencia API.

Siguiente lectura