Saltar al contenido principal
Las APIs de Lerian ofrecen acceso confiable, escalable y seguro a todo lo que proporciona la plataforma, desde flujos de trabajo de incorporación y gestión de libros contables hasta plugins para autenticación, tarifas, CRM y reportes. Esta sección es su puerta de entrada a cada API en el ecosistema de Lerian, organizada por producto. Ya sea que esté integrando directamente con Midaz o automatizando reportes con Reporter, encontrará la referencia completa aquí, incluyendo cualquier API de plugin relacionada.

​
Estructurado por producto, consciente de plugins

Cada producto—como Midaz o Reporter—tiene su propia sección de API. Cuando un producto admite plugins (por ejemplo, Midaz), esas APIs de plugin se incorporan dentro de la referencia de ese producto. Esto facilita la comprensión del área de superficie completa de lo que está integrando. Por ejemplo, dentro de la referencia de Midaz, encontrará APIs para entidades principales (como Libros Contables y Transacciones), así como para plugins como Pix, CRM y Fee Engine.

​
Aspectos destacados clave

  • RESTful y predecible: Todos los endpoints siguen métodos HTTP estándar y códigos de estado.
  • Formatos consistentes: Las solicitudes y respuestas usan JSON, con tipado y estructuras claros.
  • Versionado explícito: Las APIs están versionadas para prevenir cambios disruptivos.
  • Arquitectura con prioridad en plugins: Las características son modulares—cada plugin tiene su propio conjunto de API, documentado junto al producto que extiende.
¿Trabajando en un plugin o integración personalizada?Visite el Hub de Socios para estándares de desarrollo, pautas de documentación y herramientas.Recomendado para socios, clientes y equipos internos que trabajan en plugins personalizados.

​
Lo que encontrará aquí

  • Primeros Pasos: Guía de inicio rápido, instrucciones de sandbox y cómo funciona el modelo de licenciamiento de Lerian.
  • Fundamentos de Integración: Conceptos como reintentos, paginación, metadatos y herramientas de estabilidad.
  • Estabilidad y Calidad: Manejo de errores, mejores prácticas de prueba, proceso de QA y cobertura de soporte.
  • APIs de Productos:
    • Midaz: Libros Contables, Transacciones, Activos, Cuentas, Portafolios y extensiones de plugins
    • Reporter: Creación de reportes, carga de plantillas, filtros y exportaciones de reportes
  • Listas de Errores: Cada producto y plugin incluye referencias dedicadas de códigos de error.
Está viendo la documentación de la versión actual de las APIs de Lerian.Si está trabajando con una versión anterior, use el selector de versión (arriba a la izquierda) para acceder a la documentación heredada y evitar problemas de compatibilidad.

​
Versiones actual vs anteriores

Mantenemos documentación para ambas:
  • Versión actual: Las características más actualizadas, con soporte activo.
  • Versión anterior: Obsoleta pero aún disponible con soporte parcial por tiempo limitado.
Use el selector de versión en la parte superior izquierda de la pantalla para asegurarse de que está leyendo la documentación correcta para su entorno. Y si algo no está claro, déjenos saber—siempre estamos evolucionando la documentación para satisfacer sus necesidades.

​
Cómo navegar

Para acceder a la referencia de un producto:
1
Ya está en la sección de Referencia de API de nuestra documentación.
2
Abra el menú desplegable en la barra lateral izquierda y seleccione el producto con el que está trabajando—como Midaz o Reporter.
3
Llegará a un espacio dedicado con detalles de API específicos del producto—incluyendo plugins relacionados, referencias de esquema completas y ejemplos de payload del mundo real.