Bem-vindo ao guia de referências da API da EAD Plataforma! É através dessa API que você integra o seu sistema ao nosso.

Nossa API é RESTful, e todas suas respostas são em JSON, no endpoint base:

https://suaescola.eadplataforma.app/api/doc/v1

A seguir, algumas convenções de nossa API:

Paginação

Há muitas rotas de listagem de entidades na API. Em todas elas é necessário lidar com um sistema de paginação para percorrer todas as instâncias. Esse sistema refere-se aos parâmetros limit e offset.

limit representa o número máximo de dados retornados em cada página, valor padrão 1000. Já o offset indica o início da leitura, caso não informado valor padrão será 0.

Autenticação

Sempre que a sua aplicação chama algum de nossos endpoints, você deve passar como forma de autenticação a sua API Key, chave que pode ser encontrada clicando no menu lateral EAD Store > aba API > API EAD Plataforma > Aba Configuração.

A API Key pode ser informada apenas no cabeçalho da requisição com o parâmetro x-auth-token.

Clique no botão Ver Documentação para abrir a lista de rotas da API. Copie o token para realizar os testes na sandbox.

Clique no botão Authorize para inserir seu token caso queira testar as rotas na sandbox.

Basta clicar em Authorize e passar os parâmetros na rota desejada. Quando quiser encerrar as verificações, abra essa modal novamente e clique em Log out.