Novidades · Documentação da API

O que mudou em cada versão da API e como o EduPay cuida das mudanças.

Política de mudanças

Dentro da v1, nada quebra. O que pode entrar sem aviso: campos novos nas respostas, rotas novas, eventos novos, valores novos em listas de situação e códigos de erro novos. Escreva a integração para ignorar o que não conhece.
Mudança que quebra vai para uma versão nova (/api/v2), anunciada nesta página. A v1 continua funcionando durante a transição.
O code dos erros não muda de significado. O texto de detail pode mudar.
As rotas do plugin do Moodle (/api/moodle/*) seguem congeladas: o plugin instalado nas escolas continua funcionando sem atualização.

Primeira versão pública.

Conexão: chaves por escola, com permissões, validade, troca com 24 horas de convivência e revogação. API ligada pela escola em Integrações → Tokens de API.
Consultas: catálogo (ofertas, trilhas, turmas, planos de pagamento, páginas de vendas), alunos e resumo financeiro, matrículas e contratos (com PDF), parcelas com os dados para pagar.
Escritas: cadastrar e alterar aluno, criar e cancelar matrícula, 2ª via de parcela e link de entrada no portal do aluno. Repetição segura com Idempotency-Key.
Avisos automáticos: 13 eventos de aluno, matrícula, contrato e parcela, assinados com HMAC-SHA256, com novas tentativas por 24 horas.
Convenções: erros em problem+json com code estável, dinheiro em centavos, datas em UTC, listas com cursor, mensagens em português, inglês e espanhol.
Especificação OpenAPI 3.1 em https://edupay.estudiosite.com/api/v1/openapi.json.