Skip to main content
Esta sección es para desarrolladores e integradores técnicos. Para una visión general de negocio de lo que hacen los productos de Lerian, empieza con Quiénes somos. También puedes explorar páginas de productos individuales como Acerca de Midaz y ¿Qué es Matcher?.
Las API de Lerian cubren todo lo que ofrece la plataforma, desde workflows de incorporación y gestión del ledger hasta plugins de autenticación, CRM e informes. Esta sección documenta cada API del ecosistema de Lerian, organizada por producto, incluidas las API de los plugins relacionados.

​
Estructurado por producto, con soporte para plugins

Cada producto, como Midaz o Reporter, tiene su propia sección de API. Cuando un producto admite plugins (por ejemplo, Midaz), la referencia de ese producto incorpora las API de esos plugins. Por ejemplo, la referencia de Midaz tiene API para entidades principales como Ledgers y Transactions. También cubre el Fees Engine, parte de la familia de productos Midaz, y plugins como Pix y CRM.

​
Aspectos clave

  • RESTful y predecible: todos los endpoints siguen métodos y códigos de estado HTTP estándar.
  • Formatos consistentes: las solicitudes y las respuestas usan JSON, con tipos y estructuras claras.
  • Versionado explícito: las API tienen versión para evitar cambios que rompan la compatibilidad.
  • Arquitectura orientada a plugins: las funciones son modulares. Cada plugin tiene su propio conjunto de API, documentado junto con el producto que extiende.

​
Qué encontrarás aquí

  • Primeros pasos: guía de inicio rápido, instrucciones de sandbox y cómo funciona el modelo de licencias de Lerian.
  • Fundamentos de integración: conceptos como reintentos, paginación, metadatos y herramientas de estabilidad.
  • Estabilidad y calidad: manejo de errores, buenas prácticas de pruebas, proceso de control de calidad y cobertura de soporte.
  • API de productos:
    • Midaz: Ledgers, Transactions, Assets, Accounts, Portfolios y extensiones de plugins
    • Reporter: creación de informes, carga de plantillas, filtros y exportación de informes
  • Listas de errores: cada producto y plugin incluye referencias dedicadas de códigos de error.
Estás viendo la documentación de la versión actual de las API de Lerian.Si trabajas con una versión anterior, usa el selector de versión (arriba a la izquierda) para acceder a la documentación heredada y evitar problemas de compatibilidad.

​
Versiones actuales y anteriores

Mantenemos documentación para ambas:
  • Versión actual: las funciones más recientes, con soporte activo.
  • Versión anterior: en desuso, pero disponible con soporte parcial durante un tiempo limitado.
Usa el selector de versión en la parte superior izquierda de la pantalla para asegurarte de leer la documentación correcta para tu entorno. Si algo no queda claro, avísanos.

​
Cómo navegar

Para acceder a la referencia de un producto:
1
Ya estás en la sección de Referencia de API de nuestra documentación.
2
Abre la lista desplegable en la barra lateral izquierda y selecciona el producto con el que estás trabajando, como Midaz o Reporter.
3
Llegarás a un espacio dedicado con detalles de API específicos del producto, incluidos los plugins relacionados, referencias completas de esquemas y ejemplos reales de payloads.