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 →

Recursos

Escolas

Consulte os dados das escolas vinculadas ao seu cliente.

Ver endpoints →

Alunos

Gerencie alunos, fotos e matrículas de forma programática.

Ver endpoints →

Frequências

Registre entradas e saídas de alunos via biometria ou QR Code.

Ver endpoints →

Verificação Dupla

Controle o acesso de responsáveis com o sistema de verificação em duas etapas (TSSV).

Ver endpoints →