MyPay es una API de pagos con enfoque multi-tenant que se integra con un procesador (NMI). Separa claramente:Administración (tenants, terminals, secretos) protegida con JWT.
Pagos y consultas protegidos con X-Api-Key por tenant/terminal.
Antes de empezar#
Define tus ambientes (QA, Staging, Producción) y el host de cada uno.
Ten una X-Api-Key activa por tenant y una security_key por terminal (gestionada en secreto).
Usa datos de prueba; nunca incluyas credenciales reales en clientes públicos.
Tu primer recorrido#
1.
Autentícate para tareas administrativas y obtén un JWT (solo para endpoints de admin).
2.
Crea un tenant con su información corporativa.
3.
Crea un terminal vinculado al tenant y registra la security_key en el gestor de secretos.
4.
Procesa un cobro con el endpoint de pagos utilizando X-Api-Key (no requiere JWT).
5.
Consulta la transacción o reporte los movimientos con los endpoints de consulta/reporting.
Buenas prácticas rápidas#
Trata la security_key como un secreto de alto riesgo: nunca viaja al frontend ni se imprime en logs.
Limita el acceso CORS y exige TLS en todos los ambientes.
Usa Idempotency-Key en cobros para evitar duplicados ante reintentos.
Pitfalls frecuentes#
Mezclar JWT (admin) con X-Api-Key (pagos): son canales y políticas diferentes.
Enviar datos sensibles a clientes públicos o almacenarlos en clear text.
Ignorar la rotación de secretos o ejecutar consultas sin filtros y paginación.
Siguientes pasos#
Sigue con Installation (para levantar el servicio), luego Setup (para configurar seguridad, secretos y trazabilidad) y finalmente Endpoints (referencia completa y errores simulados). Modificado en 2025-10-29 15:25:17
