Las páginas de referencia de cada endpoint están disponibles solo en inglés por ahora.
URL base
Todas las rutas se montan bajo el prefijo/api:
Forma de las rutas
La mayoría de los recursos de negocio viven bajo una sola Entidad:/api/entities (listar y crear), /api/fx-rates, /api/countries y /api/currencies, /api/onboarding/* (solo para el equipo de Sintropix) y /api/health.
{entityId} es siempre un UUID. Una solicitud sobre una Entidad a la que quien llama no tiene acceso devuelve 404, nunca 403, de modo que sondear rutas no revela si una Entidad desconocida existe.
Autenticación
Los clientes programáticos se autentican con una clave de API en el encabezadox-api-key. Las claves se crean en la aplicación de Sintropix; consulta Obtener una clave de API.
Toda solicitud que modifica datos (POST, PUT, PATCH, DELETE) debe enviar además un Actor Declarado:
x-audit-actor es una etiqueta de software autodeclarada (por ejemplo claude-opus-4.8) que se guarda tal cual en el registro de auditoría. Omitirla en una mutación devuelve 400.
Formato de las solicitudes
Las solicitudes son JSON plano. IncluyeContent-Type: application/json en cualquier solicitud con cuerpo.
400.
Formato de las respuestas
Las respuestas son el recurso en sí como JSON. No hay un envoltoriodata de nivel superior, ni un bloque meta, ni un bloque pagination en los endpoints no paginados. Cada página de referencia lista los campos que devuelve cada endpoint.
Un recurso individual se devuelve como un objeto:
/pages, más algunos informes) devuelve un objeto { rows, nextCursor }. nextCursor es null en la última página.
La paginación se habilita endpoint por endpoint, no en todo el sitio. Los endpoints sin
/pages en su ruta devuelven todas las filas y no aceptan el argumento cursor. Revisa la página de referencia del endpoint que estés llamando.Errores
Las respuestas distintas de 2xx son JSON. Toda respuesta, exitosa o fallida, lleva un encabezadox-request-id; cítalo cuando contactes a soporte.
Los errores de dominio llevan en el cuerpo un
code de tipo string estable, por ejemplo API_KEY_READ_ONLY_ERROR. Compara contra code, no contra el mensaje legible por humanos.
Límites de solicitudes
Cada clave de API está limitada a 25.000 solicitudes por hora en una ventana deslizante. Superar el límite devuelve429; no existe un contrato de encabezados X-RateLimit-* en la respuesta.

