Saltar a contenido

Referencia

Esta sección recopila información transversal de la API que aplica a múltiples endpoints: enumeraciones, formato de respuestas y límites del sistema.

Contenido

Sección Descripción
Enumeraciones Códigos de estados, tipos de incidencia, opciones de publicación
Formato de respuestas Estructura de objetos individuales y listas paginadas
Límites del sistema Límites de tamaños, cantidades y frecuencias

URL base

Entorno URL
Producción https://apientidades-pro.transparenciacanarias.org/apientidades/v1

Cabeceras comunes

Todas las peticiones autenticadas deben incluir:

Authorization: Bearer <token>
Content-Type: application/json        (solo en peticiones con body)

Todas las respuestas incluyen:

X-Correlation-ID: <uuid>             Identificador único de la petición
X-Api-Version: 1.0                   Versión de la API
Content-Type: application/json; charset=utf-8

Convenciones

Aspecto Convención
Formato JSON camelCase para nombres de campos
Fechas ISO 8601 (ej: 2026-03-25T14:30:00Z)
Fechas solo YYYY-MM-DD (ej: 2026-03-25)
Paginación Base 0 (page=0 es la primera página)
Zona horaria UTC en las respuestas de la API
Codificación UTF-8
IDs Enteros autoincrementales
Booleanos true / false (no 1 / 0)

Estructura de URLs

https://apientidades-pro.transparenciacanarias.org/apientidades/v1/{recurso}
                                              └─────┬──────┘ └┬┘ └──┬──┘
                                                área API    ver  recurso

Ruta de la API

Todas las peticiones de la API de integración se realizan bajo la ruta /apientidades/v1/*.