Documentação da API
Utilize esta documentação para acessar as funcionalidades e recursos que esta API oferece. Gerencie registros escolares, turmas, pessoal administrativo, alunos, responsáveis, frequência escolar, sistema de verificação dupla de acesso escolar e muito mais.
Iniciando a implementação
Toda requisição leva três cabeçalhos: a chave do parceiro, o slug do cliente (rede escolar) e o token de acesso a esse cliente. Integrações novas obtêm essas credenciais no Portal do Parceiro: crie um app, teste no sandbox com dados de demonstração e, depois da aprovação, conecte-o aos clientes reais.
Guias
Autenticação
Os três cabeçalhos de autenticação e as respostas quando algum deles falha.
Leia mais →Portal do Parceiro
Crie apps, gere chaves, peça acesso aos clientes e proteja a conta com verificação em duas etapas.
Leia mais →Sandbox
Desenvolva e teste a sua integração com clientes de teste, dados de demonstração e o sistema web da escola, sem tocar em dados reais.
Leia mais →Dias Letivos
Como o Quadro de Horários e o Calendário Letivo geram as aulas e dirigem a frequência.
Leia mais →Notificações
Notificações que a plataforma envia às famílias e à equipe quando a API grava dados.
Leia mais →Recursos
Frequências
Consulte o calendário e as aulas do dia de cada turma e registre a frequência por aula.
Ver endpoints →Verificação Dupla
Entenda a custódia segura de alunos (TSSV): a verificação do responsável pelo equipamento facial da escola ou pelo app móvel.
Ver endpoints →