API para integraciones

Panteum expone una API REST en JSON para que tus sistemas consulten información o intercambien datos con él. En este portal se publican solo los endpoints públicos (no requieren credenciales) y los de integración (requieren una API Key que entrega el administrador de tu entidad).

En construcción

Estamos publicando el catálogo por etapas. Si necesitas un endpoint que no aparece aquí, agenda una demo y cuéntanos tu caso.

Direcciones

Cada servicio de Panteum tiene su propia dirección dentro del dominio de tu entidad, y todas las rutas empiezan por /api/v1:

https://<servicio>.<dominio-de-tu-entidad>/api/v1/...

Por ejemplo, en la instancia de demostración el servicio de autenticación e identidad es https://auth.serviciostic.net/api/v1.

Formato de respuesta

Todas las respuestas son JSON con el mismo envoltorio:

{
  "success": true,
  "data": { },
  "message": null
}

Campo	Tipo	Descripción
success	booleano	true si la operación salió bien.
data	objeto, lista o null	El resultado.
message	texto o null	Mensaje legible para mostrar a una persona.

Los listados paginados agregan meta con page, per_page, total y last_page.

Errores

Ante un error, success es false, el código HTTP indica el tipo de error y la respuesta trae en error.code un código estable en mayúsculas que puedes usar en tu programa (en los errores de validación, error.campos detalla cada campo):

{
  "success": false,
  "error": { "code": "NO_ENCONTRADO", "detalle": "Archivo no encontrado." },
  "message": "Archivo no encontrado."
}

HTTP	Significado
400 / 422	Datos de entrada inválidos.
401	Falta la credencial o no es válida.
403	La credencial es válida pero no tiene permiso para esta operación.
404	El recurso no existe.
429	Superaste el límite de peticiones: espera y reintenta.
5xx	Error del servicio: reintenta más tarde.

Límites de uso

Cada endpoint tiene un límite de peticiones por minuto. Las respuestas incluyen las cabeceras X-RateLimit-Limit y X-RateLimit-Remaining; si recibes 429, respeta la cabecera Retry-After antes de reintentar.

Caché

Los endpoints que lo permiten devuelven ETag. Envía ese valor en If-None-Match y, si nada cambió, recibirás 304 Not Modified sin cuerpo: ahorras datos y tiempo.

Endpoints publicados

Endpoint	Acceso	Para qué
GET /api/v1/auth/marca	Público	Identidad visual de la entidad (nombre, colores, logo).