Olá, essa é a documentação eadSimples API. Este guia você encontrará informações sobre o uso da API para realizar consultas e matrículas em seus cursos usando a nossa API.
API
API é o acrônimo para Application Programming Interface (Interface de Programação de Aplicação). Através da API nossos parceiros podem usufruir das funcionalidades que oferecemos.
Esta API usa JSON como media-type padrão. Usamos em toda nossa API o padrão UTF-8.
Ativação
Antes de mais nada é necessário solicitar ao nosso suporte a ativação dessa funcionalidade no seu site. Entre em contato com o suporte eadSimples e solicite a ativação da API.
Credenciais
Feito a ativação da API na sua plataforma eadSimples, para usar os recursos da API é necessário um ClientID e ClientSecret para gerar um token de acesso. Você poderá visualizar as credencias dentro do menu "Configurações > API eadSimples" da sua plataforma eadSimples. Essa opção estará visível somente para o perfil "Administrador"
Se a opção do menu não estiver ativa ou as credenciais não estiverem ativas, entre em contato com nosso suporte eadSimples
Endpoint
Realize as chamadas para a API usando os endpoints abaixo:
Produção:https://api.{seudominio}/v1/
Sandbox:https://apisandbox.eadsimples.com.br/v1/
Token
Para realizar as requisições na API é preciso passar um token no cabeçalho da requisição.
O token é gerado a partir do endpoint abaixo. É necessário informar o ClientID e ClientSecret que disponibilizamos após a ativação da API.
O token tem prazo de validade de 1 hora. Após expirar o período é necessário gerar um novo token de acesso.
O login e senha usados para acessar a plataforma não são válidos para gerar o token de acesso a API. Em caso de dúvidas verifique com o suporte as credencias corretas para o uso da API.
Exemplo de requisição passando o token no header
Cadastro
Dados básicos para realizar o cadastro do aluno no hubEad
Estrutura
Campo
Descrição
Tipo
Obrigatório na Inclusão
Id
Id do Cadastro na plataforma eadSimples
Int
Não
Nome
Nome Completo
String(200)
Sim
CPF
CPF
String(20)
Não
Email
Email
String(50)
Sim
Login
Login de acesso a plataforma
String(50)
Sim
Senha
Senha de acesso - se não for fornecido será criada uma senha no momento do cadastro
String(20)
Não
Status
Status do cadastro: ATIVO ou INATIVO. Somente para efeitos de consulta. Na inclusão o valor será sempre ATIVO.
String(10)
Não
IDExterno
Identificador externo do cadastro - usado para vincular o cadastro no eadSimples com outra plataforma do cliente
String(100)
Não
ObsAluno
Observações sobre o aluno - campo texto para armazenar alguma outra informação relevante do aluno
String(500)
Não
Matrículas
Objeto do tipo Lista< Matrícula > - Lista todas as matrículas ativas do aluno (disponível somente para consulta por ID de cadastro)
Nas requisições em que o retorno são uma lista de objetos (Consulta e Pesquisa), a API retorna no cabeçalho as informações de paginação.
A consulta é limitada em 10 registros por página por padrão. Mas é possível aumentar o número de registros por página até o limite de 50 por página. No header seguem as informações sobre a quantidade de resultados obtidos, tamanho da página, página atual e total de páginas.
Os parâmetros aceitos são:
Parâmetro
Descrição
Tipo
Obrigatório
Observações
pageNumber
Número da Página que deseja obter o resultado
Int
Não
-
pageSize
Total de Registros Obtidos na Página
Int
Não
-
Para obter os resultados de uma página específica passe os parâmetros na requisição.
Retorna uma URL para autenticar na plataforma usando um token de autenticação.
O aluno será redirecionado automaticamente para a sua página de cursos.
O token de autenticação possui validade de 15 minutos depois de criado. Passado o período, caso tente acessar a URL, o aluno será redirecionado para a tela de login da plataforma.
Através desta requisição é possível bloquear o acesso ao curso de um aluno já matriculado. O login permanecerá ativo, somente o acesso ao curso será inativo.
Lista de Cursos Adquiridos na Venda (Carrinho de Compras)
List< CarrinhoCompra >
-
Carrinho Compra
Campo
Descrição
Tipo
Valores Possíveis
ItemId
Id do Carrinho de Compra
Int
-
Combo
Nome do Combo de Venda
String
-
CursoID
ID do Curso
Int
-
Curso
Nome do Curso
String
-
Consulta
Retorna uma lista das vendas efetuadas em um determinado período. Caso um período não seja informado, o resultado se limitará as vendas dos ultimos 7 dias.
Nas requisições em que o retorno são uma lista de objetos (Consulta e Pesquisa), a API retorna no cabeçalho as informações de paginação.
A pesquisa de vendas retorna 10 registros por página por padrão. O limite de registros é de 50 por página. No header seguem as informações sobre a quantidade de resultados obtidos, tamanho da página, página atual e total de páginas.
É possível filtrar o resultado da pesquisa por período e pelo status da venda. Os parâmetros aceitos são:
Parâmetro
Descrição
Tipo
Obrigatório
Observações
startDate
Data de Início da Venda
Data no Formato: dd/mm/aaaa
Não
Se não for informado uma data a consulta ficará restrita a vendas realizadas de 7 dias atrás
endDate
Data Final da Venda
Data no Formato: dd/mm/aaaa
Não
Se não for informado uma data a consulta ficará restrita a vendas realizadas de 7 dias atrás