API externa de Orama
Conecta tus sistemas con la API de Orama mediante un token de acceso y conoce los enlaces temporales que Orama usa para conectar o reparar un banco.
La API externa permite que tus sistemas (ERP, BI, cuadros de mando internos) consulten los datos de tesorería de Orama de forma automática con un token de acceso. El token se crea en la Configuración de tu empresa, en la pestaña Desarrolladores.
Al final de esta guía te explicamos también los enlaces temporales que Orama genera para conectar o reparar un banco.
API externa
Avanzado — La API está pensada para equipos técnicos o integradores que necesitan conectar sus propios sistemas con Orama. Si no tienes un equipo técnico, puedes exportar tus datos a Excel o enviar tu tesorería con el reporte por email.
La API externa permite que sistemas externos consulten datos de tu tesorería de forma automatizada. Por ejemplo, tu ERP puede pedir a Orama el saldo actual, las previsiones de cobro del próximo mes o el listado de partidas.
Cómo funciona
Toda la comunicación se realiza mediante peticiones HTTP (el estándar de internet). Tu sistema envía una petición a Orama con un token de acceso y Orama responde con los datos solicitados en formato JSON.
¿Cómo creo un token de acceso a la API?
Necesitas Editar en el permiso API externa (tokens) (con Ver solo los consultas). Por defecto lo tiene quien puede editar usuarios. Ver Invitar a tu equipo.
Abre el Perfil de Empresa
Ve a rueda de configuración › Perfil de Empresa (la rueda está arriba a la derecha).
Accede a la pestaña Desarrolladores
Abre la pestaña Desarrolladores. En el bloque Access token (API) se gestionan los tokens de acceso.
Crea un nuevo token
Pulsa el +. Se generará un token único que tu sistema necesitará para autenticarse.
Copia y guarda el token
Copia el token y guárdalo en un lugar seguro. Solo se muestra una vez. Si lo pierdes, tendrás que crear uno nuevo.
Importante — Un token da acceso completo a los datos de la empresa. Trátalo como una contraseña. No lo compartas por correo electrónico ni lo publiques en ningún sitio. Si sospechas que un token ha sido comprometido, elimínalo inmediatamente y crea uno nuevo.
¿Cómo uso el token en las peticiones?
Tu sistema técnico debe incluir el token en la cabecera accessToken de cada petición. Por ejemplo:
GET https://api.orama.ai/api/external/v1/tesoreria
Header: accessToken: tu-token-aqui
Documentación técnica (Swagger)
Orama incluye una documentación interactiva de todos los endpoints disponibles. Tu equipo técnico puede acceder a ella en:
https://app.swaggerhub.com/apis-docs/orama.ai/orama-api-es/v1
Allí encontrarán:
-
Lista completa de endpoints disponibles
-
Parámetros que acepta cada endpoint
-
Ejemplos de respuesta
-
La posibilidad de probar peticiones directamente desde el navegador
Comparte la URL de la documentación Swagger con tu equipo técnico o integrador. Es la referencia más completa y siempre está actualizada.
Enlaces temporales para conectar o reparar un banco
Orama no crea enlaces para que terceros vean tu tesorería. Los únicos enlaces temporales que genera sirven para que el titular de una cuenta bancaria autorice o repare la conexión de su banco, aunque no tenga usuario en Orama:
| Enlace | Para qué sirve | Validez |
|---|---|---|
| Conectar un banco | El titular de la cuenta, aunque no tenga usuario en Orama, añade el acceso a su banco | 4 horas |
| Reparar una cuenta con error | El titular resuelve el error de conexión de esa cuenta | 48 horas |
Estos enlaces no muestran ni devuelven saldos ni movimientos: solo permiten autorizar o reparar la conexión con el banco por PSD2. Pasado el plazo, el enlace deja de funcionar (muestra «El enlace ha caducado») y hay que generar uno nuevo. Ver Conectar un banco.
¿Cómo creo un acceso remoto para que el titular conecte su banco?
Ruta: rueda de configuración (arriba a la derecha) › Conectar Bancos
Abre Mis bancos
Entra en Conectar Bancos. Bajo tus bancos verás el recuadro «¿No tienes acceso a las credenciales de los bancos?».
Crea el acceso remoto
Pulsa Crear acceso remoto. Aparece el bloque Permitir acceso externo con la fecha límite del acceso (4 horas desde que lo creas). Con el botón + puedes crear otro.
Copia y envía el enlace
Pulsa Enlace para copiarlo y envíaselo al titular de la cuenta. Con él puede conectar su banco sin tener usuario en Orama.
Al terminar
Cuando el acceso finaliza, Orama te avisa por correo. Si quieres cerrarlo antes, bórralo con el icono de la papelera.
Si quieres que tu asesoría o una persona de tu equipo vea tus datos, invítala como usuario con los permisos que decidas (ver Invitar a tu equipo). Si no usa Orama, puedes enviarle tu tesorería con el reporte por email.
Preguntas frecuentes
¿Puedo compartir mi tesorería con un tercero mediante un enlace?
No. Orama no genera enlaces de lectura para terceros. Para que alguien vea tus datos, invítalo como usuario con permisos limitados o envíale el reporte por email.
¿Los enlaces temporales para conectar un banco muestran mis saldos?
No. Solo sirven para que el titular autorice o repare la conexión del banco. No muestran saldos ni movimientos y caducan a las 4 horas (conexión) o a las 48 horas (reparación de una cuenta con error).
¿Qué hago si pierdo el token de acceso a la API?
El token solo se muestra una vez, así que tendrás que crear uno nuevo. Si sospechas que un token ha sido comprometido, elimínalo inmediatamente y crea otro.
¿Puedo sacar mis datos sin usar la API?
Sí. Si no tienes equipo técnico, puedes exportar tus datos a Excel desde la rueda de configuración.
¿Dónde está la documentación técnica de la API de Orama?
En la documentación interactiva Swagger enlazada en esta página, con la lista completa de endpoints, sus parámetros, ejemplos de respuesta y la posibilidad de probar peticiones desde el navegador.
Relacionados
Configuración de usuario y empresa
Todas las opciones de tu perfil de usuario y del perfil de empresa: datos, usuarios, configuración general, emails y API.
Exportar datos
Descarga movimientos, el cuadro de tesorería, el histórico diario o la comparativa real vs previsto en Excel para informes y auditorías.
Conectar tu ERP
Cómo integrar tu software de gestión (Sage, a3innuva, Holded, Odoo, Business Central, NetSuite) con Orama para importar facturas automáticamente.
Conectar un banco
Conecta tus bancos por PSD2 con acceso de solo lectura y renueva la conexión cuando toque.