API EAD Plataforma

Nesse tutorial você pode entender mais sobre como funciona nossa API. Na documentação é possível encontrar todos os detalhes de cada rota, quais parâmetros elas precisam e qual o retorno das requisições.

Atualmente a API conta com rotas para as seguintes seções:

• Assinaturas
• Banco de Questões
• Biblioteca
• Carrinho
• Categorias
• Certificados
• Cobranças
• Cupons
• Cursos
• Módulos
• Depoimentos
• Grupos
• Log de acesso e progresso do aluno
• Matrículas
• Permissões
• Planos
• Produtos
• Provas
• Transações
• Usuários

Para acessar a API e a documentação, clique no menu lateral na opção Store > aba API:

Acesse a aba Configuração e copie o token para utilizar no próximo passo.

❗️

Atenção

Caso você queira alterar o token, será necessário atualizar todas as suas aplicações que utilizam ele. Para isso ao clicar no ícone Atualizar, confirme a alteração.

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.

Veja no exemplo abaixo como passar os parâmetros para a rota GET Library (Listagem Biblioteca) e os retornos possíveis:

Para testar a rota, clique no canto esquerdo na opção Try it out. Os campos ficarão abertos para edição. Quando quiser encerrar os testes, clique no canto esquerdo em Cancel.

Parâmetros

Biblioteca Id: Insira o ID de um registro da biblioteca para retorná-lo na lista;
Paginate: (opcional) Insira o valor 1 para retornar as seguintes informações:
---- "rowsTotal": Total de registros listados,
---- "rowsTotalDisplay": Total de registros listados com base no offset padrão que é 1000 por vez,
---- "limit": Limite de registros listados,
---- "offset": A partir de qual reigstro os dados serão listados;

Limit: Defina um limite para o retorno dos registros, por exemplo retornar apenas 50 registros (opcional);
Offset: Defina a partir de qual registro os dados serão listados, por exemplo listar dados a partir do 100º registro (opcional);

Respostas

200: Retorna com sucesso os registros requisitados;
401: Retorna erro de token incorreto;
429: Retorna erro de many requests, como segurança para não exceder o servidor com uma grande carga de requests;
500: Retorna erro interno;

Cada rota pode ter um ou outro retorno específico, então leia a documentação para entender todos os detalhes!

Uma API é composta basicamente por 4 tipos de rotas, sendo:

GET - Listagem
POST - Inserção
PUT - Atualização
DELETE - Remoção

Lembrando que ao remover algum item, ele será movido para a Lixeira.

👍

Acesse a documentação da API

Como mencionado no início, acesse o app da API na EAD Store e clique no botão Ver Documentação para visualizar as rotas do seu EAD. Mas você pode acessar a referência da documentação clicando aqui.