OpenAPI
El contrato OpenAPI de Pago46 es la referencia oficial para integrar nuestros servicios REST. Define endpoints, métodos, parámetros, payloads, respuestas y esquemas de error, ayudándote a implementar una integración más rápida y con menos retrabajo.
Recursos disponibles
- Contrato OpenAPI (YAML): Descargar especificación
- Swagger UI: Explorar y probar endpoints
- Redoc UI: Navegar la documentación
Uso recomendado para integradores
- Empieza por el contrato para entender recursos, operaciones y modelos.
- Valida autenticación y headers antes de consumir endpoints de negocio.
- Usa Swagger UI o Redoc para revisar ejemplos y comportamientos esperados.
- Genera artefactos técnicos (clientes, mocks o pruebas) desde el YAML cuando aplique a tu stack.
- Prueba en Sandbox y promueve a producción solo después de validar flujos críticos y manejo de errores.
Buenas prácticas
- Toma OpenAPI como fuente de verdad técnica durante todo el ciclo de integración.
- Implementa validaciones de esquema para prevenir errores de formato y tipos.
- Estandariza el manejo de errores con base en los códigos y respuestas documentados.
- Revisa periódicamente la documentación para identificar ajustes y nuevas capacidades.