Saltar al contenido principal
La pestaña Referencia de API de este sitio está generada a partir del archivo OpenAPI del proyecto. Ahí encontrarás todas las rutas /v1/..., métodos HTTP, esquemas de petición y respuesta, y los mismos parámetros de consulta que expone el servidor (por ejemplo search, filters, page en colecciones). Para el detalle de cada operación, navega por las etiquetas (company, bank-accounts, transactions, etc.) en el índice de la referencia.

Autenticación en la referencia

Todos los endpoints protegidos usan HTTP Bearer: cabecera Authorization con valor Bearer <token>. El esquema de seguridad en OpenAPI coincide con lo descrito en Inicio rápido.

Tokens y permisos

Crear tokens

Esta referencia no documenta la creación de claves: eso solo ocurre en app.unisaldos.com (gestión de claves de integración). Para autenticación y URL base, véase Inicio rápido.

Permisos y error 403

Para saber qué permiso exige cada ruta, puedes:
  • Consultar la tabla en Permisos de la API.
  • Tras una llamada fallida, leer el cuerpo del 403: suele incluir required_scope con el identificador que faltaba en el token.

Validación y error 422

Un 422 indica que la petición no cumple el esquema de la operación (cuerpo, query o path), en la línea de la validación con FastAPI y Pydantic. Compara tu payload y parámetros con lo que describe OpenAPI para ese endpoint y corrige antes de reintentar.