Novedades · Documentación de la API

Qué cambió en cada versión de la API y cómo EduPay maneja los cambios.

Política de cambios

Dentro de la v1, nada se rompe. Lo que puede entrar sin aviso: campos nuevos en las respuestas, rutas nuevas, eventos nuevos, valores nuevos en listas de estados y códigos de error nuevos. Escriba la integración para ignorar lo que no conoce.
Un cambio que rompe va a una versión nueva (/api/v2), anunciada en esta página. La v1 sigue funcionando durante la transición.
El code de los errores no cambia de significado. El texto de detail puede cambiar.
Las rutas del plugin de Moodle (/api/moodle/*) siguen congeladas: el plugin instalado en las escuelas sigue funcionando sin actualización.

Primera versión pública.

Conexión: claves por escuela, con permisos, expiración, cambio con 24 horas de convivencia y revocación. La escuela activa la API en Integraciones → Tokens de API.
Consultas: catálogo (ofertas, trayectos, grupos, planes de pago, páginas de ventas), alumnos y resumen financiero, matrículas y contratos (con PDF), cuotas con los datos para pagar.
Escrituras: registrar y modificar alumnos, crear y cancelar matrículas, segunda copia de cuota y enlace de acceso al portal del alumno. Repetición segura con Idempotency-Key.
Avisos automáticos: 13 eventos de alumno, matrícula, contrato y cuota, firmados con HMAC-SHA256, con nuevos intentos durante 24 horas.
Convenciones: errores en problem+json con code estable, dinero en centavos, fechas en UTC, listas con cursor, mensajes en portugués, inglés y español.
Especificación OpenAPI 3.1 en https://edupay.estudiosite.com/api/v1/openapi.json.