API do Pedagogo
A API do Pedagogo permite que outros sistemas façam o mesmo que o usuário faz nas telas: consultar e cadastrar cursos, alunos, turmas, matrículas, lançamentos e demais registros. Toda chamada é feita em nome de um usuário: a API usa o token do usuário e respeita o acesso que esse usuário tem no sistema.
Como começar
- Gere o token do usuário na tela Usuários. Cada usuário tem o seu.
- Troque o token por uma sessão
chamando
POST /auth/login-by-token. A resposta traz o token de sessão (JWT) e o instante em que ele expira. - Envie o token de sessão no cabeçalho
Authorization: Bearer ...em todas as demais chamadas.
As regras gerais (endereço base, formato das respostas, paginação, erros) estão em Convenções.
O que o token do usuário pode fazer
- O token de sessão tem o mesmo acesso do usuário que o gerou: as mesmas telas, do pacote contratado e do grupo de acesso do usuário.
- Só enxerga e altera dados da empresa cliente do usuário.
- Se o usuário ou o cliente for inativado, o token deixa de funcionar.
Por isso, crie usuários específicos para integrações, com um grupo de acesso que libere apenas as telas necessárias (veja Grupos de acesso, no módulo Administrativo).
Referência por módulo
A referência segue os módulos do menu do Pedagogo. Cada página lista os endpoints do recurso, o que cada um faz, os campos que aceita e o que devolve.