Autenticação
Envie o token no cabeçalho
Todas as operações exigem o token de API enviado diretamente no header x-auth-token, conforme os exemplos desta referência.
x-auth-token: SEU_TOKEN
API v1.5.0
Referência da API
Integre a EAD Plataforma aos seus sistemas com rotas completas, explicações guiadas, exemplos editáveis e respostas simuladas.
- 80
- rotas
- 102
- operações
- 21
- grupos
URL base
Use o domínio da sua plataforma
No endereço padrão, troque o subdomínio pelo da sua conta. Se a plataforma usa domínio personalizado, use o endereço configurado para ela.
https://SEU-SUBDOMINIO.eadplataforma.app
Requisições
Dados e formato
Quando houver corpo, envie os campos como multipart/form-data. Os parâmetros de consulta vão na query string.
Accept: application/jsonListagens
Paginação e filtros
Use apenas os parâmetros documentados em cada rota. Quando disponíveis, limit e offset controlam a paginação.
?limit=100&offset=0Respostas HTTP
Como interpretar os retornos
Cada endpoint detalha os campos retornados em cada status. A API também pode responder sem corpo.
SucessoEm 102 operações
Sem conteúdoEm 47 operações
Não autenticadoEm 102 operações
Não encontradoEm 52 operações
Dados inválidosEm 37 operações
ConflitoEm 5 operações
Muitas requisiçõesEm 102 operações
Erro internoEm 102 operações
O status 429 informa excesso de requisições. A especificação não define uma cota numérica; implemente espera progressiva antes de repetir a chamada.
Catálogo completo
102 endpoints disponíveis
Abra uma operação, use “Explique este endpoint” e monte exemplos em cURL, JavaScript (Node.js), PHP ou Python.
Assinaturas
GET/api/1/paymentListagem dos pagamentos das assinaturas do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/signatureListagem de assinaturas do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/signature/{id}Atualizar uma assinatura do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Banco de Questões
GET/api/1/questionsListagem das questões cadastradas por curso.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/questionsInserir uma questão para um curso.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/questions/{pergunta_id}Atualizar uma questão de um curso.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/questions/{id}Excluir uma questão de um curso.
Abra para carregar parâmetros, exemplos e respostas.
Biblioteca
GET/api/1/libraryListagem dos arquivos enviados na plataforma.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/library/{id}Atualizar um arquivo da biblioteca.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/library/{id}Excluir um arquivo da biblioteca.
Abra para carregar parâmetros, exemplos e respostas.
Carrinho
GET/api/1/cartListagem do carrinho do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Categorias
GET/api/1/categoryListagem de categorias de cursos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/categoryInserir uma nova categoria de cursos no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/category/{id}Atualizar uma categoria de cursos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/category/{id}Excluir uma categoria de cursos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Certificados
GET/api/1/certificateListagem com os certificados emitidos no EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/certificate/{id}Excluir um certificado.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/templatecertificateListagem dos templates de certificados do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/templatecertificate/{id}Editar um template de certificado do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/templatecertificate/{id}Excluir um template de certificado do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Cobranças
GET/api/1/chargeListagem das cobranças cadastradas no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/publishcharge/{id}Publicar uma cobrança criada no EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/charge/{id}Excluir uma cobrança do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Cupons
GET/api/1/couponListagem de cupons do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/couponInserir um novo cupom no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/coupon/{id}Atualizar um cupom do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/coupon/{id}Excluir um cupom do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Cursos
GET/api/1/courseListagem dos cursos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/courseInserir um novo curso no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/course/{id}Atualizar um curso do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/course/{id}Excluir um curso do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/course/teamListagem dos colaboradores dos cursos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/course/teamInserir um novo colaborador no curso do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/course/team/{curso_id}/{colaborador_id}Atualizar o tipo do colaborador do curso no EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/course/team/{curso_id}/{colaborador_id}Excluir um colaborador do curso no EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/lessonListagem de aulas do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/moduleListagem dos módulos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/moduleCadastro de um módulo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/module/{id}Editar um módulo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/module/{id}Remover um módulo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Depoimentos
GET/api/1/briefListagem de depoimentos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/brief/{id}Aprovar um depoimento no EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/brief/{id}Reprovar e apagar um depoimento no EAD.
Abra para carregar parâmetros, exemplos e respostas.
Gamificação
GET/api/1/gamification/seasonListagem das temporadas de gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/triggerListagem dos gatilhos de pontuação da gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/levelListagem dos níveis de gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/badgeListagem das insígnias de gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/rewardListagem das recompensas de gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/rankingRanking dos alunos em uma temporada de gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/userDados de gamificação de um aluno do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/user/badgeListagem das insígnias conquistadas pelos alunos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/user/rewardListagem das recompensas conquistadas pelos alunos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/gamification/logHistórico de pontuação da gamificação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Grupos
GET/api/1/groupListagem de grupos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/groupInserir um novo grupo no EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/groupstudent/{id}Listagem de alunos por grupos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/groupcourse/{id}Listagem de cursos por grupos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/groupstudentInserir um aluno em um grupo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/groupcourseInserir um curso em um grupo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/group/{id}Atualizar um grupo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/group/{id}/{excluir_matriculas}Excluir um grupo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/groupstudent/{id}/{usuario_id}/{excluir_matriculas}Excluir um aluno de um grupo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/groupcourse/{id}/{curso}/{excluir_matriculas}Excluir um curso de um grupo do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Log de acesso e Progresso do aluno
GET/api/1/progressProgresso dos alunos em um curso.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/logListagem de log visualização de aula.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/logExcluir log e progresso de um aluno em um curso, módulo ou aula.
Abra para carregar parâmetros, exemplos e respostas.
Matrículas
GET/api/1/enrollmentListagem de matrículas do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/enrollmentInserir uma matrícula no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/enrollment/{id}Atualizar uma matrícula do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/enrollment/{id}/{removeExams}Excluir uma matrícula do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Matrículas Conteúdo Único
GET/api/1/enrollment/contentListagem de matrículas conteúdo único do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/enrollment/contentInserir uma matrícula de conteúdo único no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/enrollment/content/{id}Atualizar uma matrícula de conteúdo único do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/enrollment/content/{id}Excluir uma matrícula de conteúdo único do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Permissões
GET/api/1/permissionListagem dos templates de permissões cadastrados no EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/userpermissionListagem dos templates de permissões e usuários cadastrados no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/permission/{id}/{usuario_id}Alterar template de permissões de um usuário.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/permission/{id}Excluir um template de permissão cadastrado no EAD.
Abra para carregar parâmetros, exemplos e respostas.
Planos
GET/api/1/planListagem de planos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/plancoursesListagem dos cursos de um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/plancoursesInserir um curso em um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/plancontentsListagem dos conteúdos de um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/plancontentsInserir um conteúdo em um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/plan/{id}Excluir um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/plancourses/{id}/{curso}Excluir um curso de um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/plancontents/{id}/{conteudo}Excluir um conteúdo de um plano do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Produtos
GET/api/1/productListagem dos produtos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/product/offerListagem das ofertas dos produtos no EAD.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/product/opportunityListagem das oportunidades do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Provas
GET/api/1/testListagem das provas realizadas pelo aluno dentro de um curso.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/testsRetorna as provas realizadas no EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/test/{id}/{curso_id}/{aluno_id}Excluir uma prova de um aluno.
Abra para carregar parâmetros, exemplos e respostas.
Transações
GET/api/1/salesListagem de vendas dos cursos do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/sales/{id}Excluir uma transação do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Usuários
POST/api/1/loginLogar um usuário no EAD através de um link.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/login/ssoLogar um usuário no EAD através de um link.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/accessListagem do histórico de acesso de um usuário.
Abra para carregar parâmetros, exemplos e respostas.
GET/api/1/studentListagem dos usuários do EAD.
Abra para carregar parâmetros, exemplos e respostas.
POST/api/1/studentInserir um novo usuário no EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/student/{aluno_id}Atualizar um usuário do EAD.
Abra para carregar parâmetros, exemplos e respostas.
PUT/api/1/student/{aluno_id}/notifyAtualizar notificações de um usuário do EAD.
Abra para carregar parâmetros, exemplos e respostas.
DELETE/api/1/student/{id}Excluir um usuário do EAD.
Abra para carregar parâmetros, exemplos e respostas.
Nenhum endpoint encontrado
Tente outro termo ou remova o filtro de método.