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
Para começar, acesse sua conta com as credenciais de cliente. Será necessário que você obtenha sua chave API e token de parceiro para autenticação. Com as credenciais configuradas, você poderá realizar as requisições HTTP em nossa API.
Guias
Primeiros passos
Saiba como funciona o processo de onboarding e como realizar sua primeira requisição à API.
Leia mais →Autenticação
Saiba como autenticar suas requisições utilizando os cabeçalhos de API da plataforma.
Leia mais →Paginação
Entenda o formato das respostas e como trabalhar com coleções de dados retornadas pela API.
Leia mais →Erros
Conheça os diferentes tipos de erros retornados pela API e como tratá-los na sua integração.
Leia mais →Dias Letivos
Entenda como o Quadro de Horários e o Calendário Letivo se materializam em aulas e dirigem o lançamento de frequência.
Leia mais →Recursos
Verificação Dupla
Controle o acesso de responsáveis com o sistema de verificação em duas etapas (TSSV).
Ver endpoints →ERP — Gestão Escolar
Módulos ERP
Financeiro, estoque e merenda, patrimônio, biblioteca, CRM, RH, visitantes, saúde, eventos, exercícios e suporte — requisitos, convenções e webhooks.
Visão geral →Financeiro
Consulte contratos, mensalidades, contas a pagar e o resumo do período, e receba o aviso de cada pagamento.
Ver endpoints →CRM de Prospecção
Envie leads do seu site direto para o funil de matrícula da escola e acompanhe cada etapa.
Ver endpoints →Biblioteca
Acervo, leitores e circulação — empréstimos, devoluções e renovações com as regras da escola.
Ver endpoints →