API — Changelog

Acompanhe as atualizações, melhorias e correções implementadas em nossa API. Fique por dentro das novidades e mudanças que impactam a integração e o uso dos nossos serviços.

Quarta-feira, 14 de Outubro de 2026
Portaria pelos equipamentos faciais e códigos nas recusas
A entrada e a saída na portaria passam a ser registradas pelos equipamentos faciais Control iD e Topdata, conectados diretamente ao Lumen e gerenciados pelo próprio sistema. Os endpoints usados por totens de parceiros foram removidos; para acompanhar a portaria, assine os webhooks. Veja Webhooks e Erros.
Endpoints removidos
  • GET /v1/attendance/student/verify, POST /v1/attendance/student/biometric/check/in, POST /v1/attendance/student/biometric/check/out e POST /v1/tssv/responsible/check/in. Use os webhooks attendance.check_in, attendance.check_out e tssv.responsible_check_in;
  • PATCH /v1/partners/school/{cnpj}/student/{enrollment_number}/photo/status e PATCH /v1/partners/school/{cnpj}/responsible/{cpf}/photo/status. O status da foto é definido no cadastro da pessoa nos equipamentos e continua chegando pelos webhooks student.photo_status_updated e responsible.photo_status_updated.
Novidades
  • Alunos: o aluno ganha o campo photo (base64 ou null). As listagens GET /v1/partners/students/all e …/school/{cnpj}/students/all aceitam with_photo=false para omitir a foto;
  • Webhooks: novo evento classroom_schedule.saved, disparado quando a grade de períodos de uma turma é salva pela API;
  • Recusas por regra de negócio: as respostas 422 e 409 passam a trazer o campo code (HAS_ENROLLMENTS, HAS_SCORES, HAS_STUDENTS, IN_USE_BY_CLASSROOM, IN_USE_BY_TIMETABLE, IN_USE_GRADE, IN_USE_TEACHER e HAS_ONGOING_SESSION), para tratar cada caso sem depender da mensagem;
  • DELETE /v1/partners/school/{cnpj}/responsible/{cpf} responde 422 com "code": "HAS_STUDENTS" enquanto houver alunos vinculados ao responsável;
  • DELETE /v1/partners/school/{cnpj}/form-of-evaluation/{id} responde 422 com "code": "IN_USE_BY_CLASSROOM" quando a forma de avaliação está em uso por alguma turma;
  • Autorizações: o acesso passa a ser controlado pelas permissões view auth, approve auth e deny auth. Além da Direção, os perfis Gestão e Rede passam a aprovar e rejeitar autorizações por padrão.
Correções
  • Fotos: PUT …/student/{enrollment_number}/photo e PUT …/responsible/{cpf}/photo respondem 404, e não mais 422, quando o aluno ou o responsável não existe;
  • Fotos: with_photo=false era ignorado nas listagens de alunos e responsáveis, que sempre traziam a foto;
  • Documentação: os exemplos de Turmas usavam o host api.lumenerp.app.br; o correto é lumenerp.app.br. Os guias Erros, Paginação, Notificações, Webhooks e Consistência de Dados foram revisados para descrever o comportamento real da API.
Quarta-feira, 7 de Outubro de 2026
Novo sandbox, com clientes de teste por app
O sandbox passa a ser uma instância separada do Lumen, em https://sandbox.lumenerp.app.br. Cada app tem os seus próprios clientes de teste, e o desenvolvedor pode entrar no sistema e usá-lo como a escola. Veja Sandbox e Sandbox e produção.
  • Chaves de teste (lmn_test_) passam a funcionar só em https://sandbox.lumenerp.app.br/api/v1. Em produção, elas recebem 403 com "code": "SANDBOX_HOST";
  • Cada app cria, na aba Credenciais, uma rede privada e uma rede pública (SEDUC) só suas, com uma escola cheia de dados de demonstração para todos os endpoints de leitura, e pode recriá-las quando quiser;
  • Com o botão "Entrar no sandbox", o desenvolvedor usa o sistema web como a rede de ensino e cadastra o que quiser, inclusive novos usuários. E-mails, SMS, WhatsApp e push vão para a Caixa de saída do sandbox;
  • Pagamentos e assinaturas eletrônicas são simulados por páginas próprias do sandbox, e a escola recebe a confirmação como em produção;
  • Os webhooks de teste agora são enviados para tudo o que acontece nos clientes do app — chamadas à API, ações feitas no sistema e rotinas automáticas — e não só para as chamadas à API;
  • Novo quadro Dados de teste em cada cliente, com um valor para cada parâmetro de caminho (turma, matrícula, CPF, aula, nota, evento, meta…) e o ID de um registro de cada recurso;
  • Cada cliente de teste tem a chave Gestão Escolar (ERP), para testar a integração com clientes do plano simplificado.
Plano Gestão Escolar (ERP) na API
  • Os endpoints dos módulos do plano Gestão Escolar (ERP) — frequência por aula, notas e boletins, exercícios, diário de classe e plano de aula, ocorrências disciplinares, conselho de classe, quadro de horários da turma, plano de curso, eventos, biblioteca, contratos de matrícula, CRM, cursos online e metas — passam a responder 403 com "code": "ERP_REQUIRED" para clientes do plano simplificado, como já acontece no sistema web. Clientes do plano Gestão Escolar não são afetados, e os demais endpoints continuam respondendo a todos os clientes. Cada página da referência indica os endpoints afetados.
Correções
  • Aulas: corrigido o erro 500 em GET /v1/partners/school/{cnpj}/lesson/all e …/lesson/{id} quando a aula tinha data de publicação;
  • Horários: corrigido o erro 500 em GET e PUT /v1/partners/school/{cnpj}/weekly-schedule;
  • Gravações: registros criados pela API sem escola informada no corpo passam a ficar na escola do {cnpj} da rota.
Quarta-feira, 7 de Outubro de 2026
Tolerância de entrada obrigatória nos horários
A falta de um aluno é registrada no horário de entrada mais a tolerância do turno, então todo turno com horário de entrada passa a exigir a sua tolerância. Veja Horários.
  • PUT /v1/partners/school/{cnpj}/global-schedule: um turno com {turno}_checkin precisa de {turno}_checkin_tolerance. Use "00:00" para nenhuma tolerância;
  • PUT /v1/partners/school/{cnpj}/weekly-schedule: com qualquer horário de entrada na semana, checkin_tolerance é obrigatório;
  • A regra vale para o horário como ele fica salvo: enviar só o horário de entrada funciona quando a tolerância já está salva, e enviar a tolerância como null enquanto o turno tem entrada é recusado;
  • Sem a tolerância, a API responde 422 com o campo em errors, por exemplo "morning_checkin_tolerance".
Correções
  • Horários: a referência indicava 400 para formato de horário inválido em PUT …/global-schedule; a resposta é 422.
Sexta-feira, 02 de Outubro de 2026
Portal do Parceiro, sandbox e novos perfis
Novas integrações podem ser criadas e testadas de forma autônoma no Portal do Parceiro, sem depender de credenciais emitidas manualmente. A autenticação continua usando os cabeçalhos X-Partner, X-Client e X-Authorization; as credenciais já existentes seguem funcionando sem alterações.
  • Novo guia Portal do Parceiro e nova seção na página de Autenticação: chaves lmn_test_… acessam um sandbox com dados de demonstração, isolado da produção; chaves lmn_live_… e tokens de conexão lmn_conn_… acessam a produção, após a aprovação do app;
  • Toda resposta de apps do portal inclui o cabeçalho X-Lumen-Environment (test ou live) e os limites de requisição por minuto (X-RateLimit-*). Novas respostas: 403 para app não aprovado ou suspenso, 429 para limite excedido e 503 para sandbox em manutenção;
  • Webhooks de apps do portal seguem o padrão Standard Webhooks (webhook-id, webhook-timestamp e webhook-signature, assinatura HMAC-SHA256). O envelope ganha os campos id, environment e client, e entregas com falha são reenviadas até 5 vezes;
  • Horário de Entrada, Saída e Tolerância: novo turno morningafternoon (Manhã/Tarde) nos horários globais e semanais da escola, com os campos morningafternoon_checkin, morningafternoon_checkout e morningafternoon_checkin_tolerance;
  • Perfis de Acesso: documentados os perfis especializados NUTRITIONIST, NURSE, LIBRARIAN, ASSISTANT_LIBRARIAN, AUDITOR e INSPECTOR e os perfis de portal RESPONSIBLE, STUDENT e EMPLOYEE, com a matriz de permissões padrão de cada um.
Sexta-feira, 12 de Junho de 2026
Notificações in-app
A plataforma passa a gerar notificações in-app automaticamente em resposta a eventos do sistema. As notificações são persistidas no banco de dados e ficam disponíveis para leitura no aplicativo mobile, sem depender de serviços de push externos.
  • Responsáveis recebem notificações para: novos recados, recados atualizados, novas aulas, aulas atualizadas, ausências, notas lançadas, ocorrências disciplinares (não confidenciais), resultado do conselho de classe, respostas no atendimento e ficha médica atualizada;
  • Coordenadores recebem notificação quando uma nova aula aguarda aprovação;
  • Secretários recebem notificações para: novos chamados de atendimento, mensagens diretas de responsáveis, atualizações de ficha médica e tentativas de check-in não autorizadas;
  • Professores recebem notificação quando um plano de curso é criado ou atualizado para uma disciplina que lecionam.
Quarta-feira, 20 de Maio de 2026
Atualizações em turmas, autorizações e novos endpoints
Novo: Calendário Letivo, Frequências, Diário de Classe, Ocorrências Disciplinares, Plano Pedagógico, Conselho de Classe;
  • As rotas dos endpoints de quadros de horário foram alteradas;
  • Novos webhooks para Quadro de Horários, Diário de Classe, Plano Pedagógico, Ocorrências Disciplinares e Conselho de Classe;
Segunda-feira, 07 de Maio de 2026
Atualizações em matrículas e novos endpoints
Novo: Autorizações;
Novos endpoints para matrículas, incluindo transferência interna, transferência externa, solicitação de atualização de status e solicitação de reativação, proporcionando uma gestão mais flexível e completa das matrículas dos alunos.
Sábado, 09 de Maio de 2026
Novos endpoints para entidades e recursos da escola
Coordenadores, Secretários, Professores, Disciplinas, Tipos de Aula, Carga Horária, Plano de Curso (BNCC), Séries e Anos, Disciplinas da Escola, Portões de Entrada da Escola, Horários de Entrada, Saída e Tolerância, Espaços Físicos da Escola, Quadro de Disponibilidade da Turma, Quadro de Disponibilidade do Professor, Quadro de Horários da Turma;
Quinta-feira, 07 de Maio de 2026
Atualizações em modelos, webhooks e novos endpoints de ano letivo
  • Novos campos adicionados ao modelo do aluno;
  • Novos campos adicionados ao modelo de escola;
  • Novas informações disponíveis nos webhooks de aluno;
  • Ano Letivo: Novos endpoints disponíveis;
Quinta-feira, 30 de Abril de 2026
Novos endpoints de responsáveis
Adicionados novos endpoints para vincular e desvincular responsáveis legais e adicionais aos alunos, proporcionando uma gestão mais flexível e completa das informações dos estudantes.
Quinta-feira, 30 de Abril de 2026
Versão 1.0
Lançamento oficial da API Lumen ERP, oferecendo uma ampla gama de endpoints para integração. A versão 1.0 inclui funcionalidades essenciais para gerenciamento de alunos, turmas, frequência, responsáveis, eventos entre outros, proporcionando uma base sólida para que desenvolvedores integrem suas aplicações com a plataforma Lumen ERP.