Estructurado por producto, con soporte para plugins
Cada producto, como Midaz o Reporter, tiene su propia sección de API. Los plugins, como las interfaces de Pix y TED, tienen sus propias secciones en Interfaces. Por ejemplo, la referencia de Midaz tiene API para entidades principales como Ledgers y Transactions. También cubre Fees y CRM, que forman parte de Midaz.
Aspectos clave
- Arquitectura orientada a plugins: las funciones son modulares. Cada plugin tiene su propio conjunto de API.
Qué encontrarás aquí
- 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.
- Listas de errores: cada referencia de API incluye una referencia dedicada de códigos de error.
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, referencias completas de esquemas y ejemplos reales de payloads.