Introdução Última atualização: 2024-05-23

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{cliente}.eadsimples.com.br/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.

  • Produção: https://api{seudominio}.eadsimples.com.br/token
  • Sandbox: https://apisandbox.eadsimples.com.br/token

Exemplo de geração do token no POSTMAN

Captura de tela do Postman para gerar o token de acesso

Importante

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

Request Header com token de acesso

Cadastro

Dados básicos para realizar o cadastro do aluno na plataforma

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) Lista< Matrículas > Não

Consulta

Retorna uma lista de alunos da plataforma. O número de registros é limitado, verifique no header a quantidade de registros e paginação.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/getall
GET Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/getall

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/cadastro/getall

Response

[
    {
        "Id":6556,
        "Nome":"Joao da Silva",
        "CPF":"11111111111",
        "Email":"[email protected]",
        "Login":"[email protected]",
        "Status":"ATIVO",
        "IDExterno":"COL01644",
        "ObsAluno":""        
    },
    {
        "Id":6551,
        "Nome":"Maria da Silva",
        "CPF":"",
        "Email":"[email protected]",
        "Login":"maria.silva",
        "Status":"ATIVO",
        "IDExterno":"COL01087",
        "ObsAluno":"Estagiária"
    },
    {
        "Id":6555,
        "Nome":"Marcelo da Ramos",
        "CPF":"22222222222",
        "Email":"[email protected]",
        "Login":"22222222222",
        "Status":"INATIVO"        
    }
]

Paginação

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 -
Exemplo do header com as informações de paginação

Para obter os resultados de uma página específica passe os parâmetros na requisição.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/getall?pageNumber=2&pageSize=50
GET Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/getall?pageNumber=2&pageSize=50

Consulta por ID

Retorna as informações de um aluno específico informando o ID de cadastro.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/get/{Id}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/get/{Id}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/cadastro/get/6556

Response


    {
        "Id":6556,
        "Nome":"Joao da Silva",
        "CPF":"11111111111",
        "Email":"[email protected]",
        "Login":"[email protected]",
        "Status":"ATIVO",
        "IDExterno":"COL01644",
        "ObsAluno":"",
        "Matriculas":[
                        {
                                "CadastroId":6556,
                                "CursoId":18,
                                "Curso":"Business Intelligence",
                                "DataMatricula":"2021-20-20T15:31:00",
                                "DataAcesso":"2023-10-20T15:31:00",
                                "StatusMatricula":"ATIVO",
                                "SituacaoAluno":"Cursando"
                        },
                        {
                                "CadastroId":6556,
                                "CursoId":34,
                                "Curso":"Calculadora HP12C",
                                "DataMatricula":"2020-03-16T17:26:00",
                                "DataAcesso":"2021-03-16T10T17:26:00",
                                "StatusMatricula":"INATIVO",
                                "SituacaoAluno":"Egresso"
                        }
                    ]
                                           
    }

Pesquisa

Retorna uma lista de alunos que obedeçam ao critério de pesquisa informado. O parâmetro informado pode ser parte do nome, email ou cpf. O número de registros é limitado, verifique no header a quantidade de registros e paginação.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/search/{termo da pesquisa}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/search/{termo da pesquisa}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/cadastro/search/silva

Response

[
    {
        "Id":6556,
        "Nome":"Joao da Silva",
        "CPF":"11111111111",
        "Email":"[email protected]",
        "Login":"[email protected]",
        "Status":"ATIVO",
        "IDExterno":"COL01644",
        "ObsAluno":""        
    },
    {
        "Id":6551,
        "Nome":"Maria da Silva",
        "CPF":"",
        "Email":"[email protected]",
        "Login":"maria.silva",
        "Status":"ATIVO",
        "IDExterno":"COL01087",
        "ObsAluno":"Estagiária"
    }
]

Inclusão

Através desta requisição é possível realizar o cadastro de um aluno.

Um e-mail é enviado para o aluno com os dados de acesso: login e senha na inclusão do cadastro.

Estrutura para Inclusão

Campo Descrição Tipo Obrigatório
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
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
POST Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/add
POST Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/add

Exemplo de requisição de inclusão
https://apisandbox.eadsimples.com.br/v1/cadastro/add

{
                                "Nome":"José Ramos",
                                "Email":"[email protected]",
                                "Login":"jose.ramos",
                                "Senha":"nqZfkUf4BS",
                                "IDExterno":"CLI1052"
}

Response

{
                                "Id":6590,
                                "Nome":"José Ramos",
                                "Email":"[email protected]",
                                "Login":"jose.ramos",
                                "IDExterno":"CLI1052"
                                
}

Alteração

Através desta requisição é possível alterar algumas informações do cadastro de um aluno.

Não é necessário enviar todos os campos na requisição, somente os campos a serem alterados.

O login e senha não são possíveis de alterar por meio desta requisição. Somente acessando a plataforma isso será possível.

Estrutura para Alteração

Campo Descrição Tipo Obrigatório
Id Id do Cadastro Int Sim
Nome Nome Completo String(200) Não
CPF CPF String(20) Não
Email Email String(50) 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
POST Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/update
POST Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/update

Exemplo de requisição de alteração
https://apisandbox.eadsimples.com.br/v1/cadastro/update

{
                                "Id":6590,
                                "Nome":"José Rammos",
                                "Email":"[email protected]"
}

Response

{
                                "Id":6590,
                                "Nome":"José Ramos",
                                "Email":"[email protected]"
                                
}

Inativar

Através desta requisição é possível inativar o cadastro de um aluno. Após esta operação o aluno não conseguirá realizar o login e acessar os cursos.

POST Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/disable/{id}
POST Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/disable/{id}

Exemplo de requisição de inativação
https://apisandbox.eadsimples.com.br/v1/cadastro/disable/6556

Response


    {
            "Id":6556,
            "Nome":"Joao da Silva",
            "CPF":"11111111111",
            "Email":"[email protected]",
            "Login":"[email protected]",
            "Status":"INATIVO",
            "IDExterno":"COL01644",
            "ObsAluno":""
    }

Reativar

Através desta requisição é possível reativar o cadastro de um aluno que foi inativado.

POST Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/activate/{id}
POST Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/activate/{id}

Exemplo de requisição de exclusão
https://apisandbox.eadsimples.com.br/v1/cadastro/activate/6556

Response


    {
        "Id":6556,
        "Nome":"Joao da Silva",
        "CPF":"11111111111",
        "Email":"[email protected]",
        "Login":"[email protected]",
        "Status":"ATIVO",
        "IDExterno":"COL01644",
        "ObsAluno":""
    }

Login

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.

Estrutura para obter o token

Campo Descrição Tipo Obrigatório
Id Id do Cadastro Int Sim
Login Login do aluno na plataforma String(50) Sim
POST Produção https://api{seudominio}.eadsimples.com.br/v1/cadastro/login
POST Sandbox https://apisandbox.eadsimples.com.br/v1/cadastro/login

Exemplo de requisição
https://apisandbox.eadsimples.com.br/v1/cadastro/login

{
    "Id":6590,
    "Login":"[email protected]",                                
}

Response

{
    "https://{seudominio}/AuthToken.aspx?token=470139709829110E572B1BE55DF7E363FA30290619959089F1C00F13AD91CBC435383AEF8C5B2AAEF0667FD2A64D79F16DF976376F4CD62B&expires=8E6A4AD56C9AE6284758E91F4A257148AF437BFF51B3D650"
                                
}

Curso

Dados somente para consulta a fim de obter o ID para realizar a matrícula.

Estrutura

Campo Descrição Tipo Obrigatório
Id Id do Curso Int Não
Nome Nome do Curso String(100) Não
Matriculados Objeto do tipo Lista< Cadastro > - Lista todas os alunos matriculados do curso (disponível somente para consulta por ID de curso) Lista< Curso > Não

Consulta

Lista os cursos ativos da instituição. O número de registros é limitado, verifique no header a quantidade de registros e paginação.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/curso/getall
GET Sandbox https://apisandbox.eadsimples.com.br/v1/curso/getall

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/curso/getall

Response

[
    {
        "Id":18,
        "Nome":"Business Intelligence"
    },
    {
        "Id":34,
        "Nome":"Calculadora HP12C",
    },
    {	
        "Id":56,
        "Nome":"Curso Mecânica Básica"
    }
]

Consulta por ID

Retorna as informações de um curso específico informando o ID do curso.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/curso/get/{Id}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/curso/get/{Id}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/curso/get/71

Response

{
    "Id":18,
    "Nome":"Business Intelligence",
    "Matriculados":[
		        {
                            "CadastroID":6556,
                            "CursoID":18,
                            "Aluno":"Joao da Silva",
                            "DataAcesso":"2021-20-20T15:31:00",
                            "DataMatricula":"2023-10-20T15:31:00",
                            "StatusMatricula":"ATIVO",
                            "SituacaoAluno":"Cursando"
                        },
			{
                            
                            "CadastroID":6970,
                            "CursoID":18,
                            "Aluno":"Daniela Visconti",
                            "DataAcesso":"2019-11-01T09:16:00",
                            "DataMatricula":"2021-11-01T09:16:00",
                            "StatusMatricula":"INATIVO",
                            "SituacaoAluno":"Egresso"
			}
		]
}

Pesquisa

Retorna uma lista de cursos que obedeçam ao critério de pesquisa informado. O parâmetro informado pode ser o nome ou parte do nome do curso. O número de registros é limitado, verifique no header a quantidade de registros e paginação.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/curso/search/{termo da pesquisa}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/curso/search/{termo da pesquisa}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/curso/search/básica

Response

[
    {	
        "Id":56,
        "Nome":"Curso Mecânica Básica"
    },    
    {	
        "Id":106,
        "Nome":"Física Básica"
    },
    {	
        "Id":87,
        "Nome":"Matemática Financeira Básica"
    },
]

Polo

Dados somente para consulta a fim de obter o ID para realizar a matrícula do aluno em um polo específico.

Estrutura

Campo Descrição Tipo Obrigatório
Id Id do Polo Int Não
Nome Nome do Polo String(100) Não
Matriculas Objeto do tipo Lista< Matrícula > - Lista todas os alunos matriculados no polo (disponível somente para consulta por ID de polo) Lista< Polo > Não
Cursos Objeto do tipo Lista< Curso > - Lista todas os cursos vinculados ao polo (disponível somente para consulta por ID de polo) Lista< Curso > Não

Consulta

Lista os polos ativos da instituição. O número de registros é limitado, verifique no header a quantidade de registros e paginação.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/polo/getall
GET Sandbox https://apisandbox.eadsimples.com.br/v1/polo/getall

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/polo/getall

Response

[
    {
                                "Id":14,
                                "Nome":"Plataforma",
                                "Status":"ATIVO"
    },
    {
                                "Id":34,
                                "Nome":"Regiao Central",
                                "Status":"ATIVO"
    },
    {	
                                "Id":56,
                                "Nome":"Interior",
                                "Status":"ATIVO"
    }
]

Consulta por ID

Retorna as informações de um polo específico informando o ID do polo.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/polo/get/{Id}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/polo/get/{Id}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/polo/get/14

Response

{
                                "Id":14,
                                "Nome":"Plataforma",
                                "Status":"ATIVO",
                                "Matriculas":[
		        {
                                    "CadastroID":6556,
                                    "CursoID":18,
                                    "Aluno":"Joao da Silva",
                                    "DataAcesso":"2021-20-20T15:31:00",
                                    "DataMatricula":"2023-10-20T15:31:00",
                                    "StatusMatricula":"ATIVO",
                                    "SituacaoAluno":"Cursando",
                                    "Polo":14
                        },
			{
                            
                                    "CadastroID":6970,
                                    "CursoID":18,
                                    "Aluno":"Daniela Visconti",
                                    "DataAcesso":"2019-11-01T09:16:00",
                                    "DataMatricula":"2021-11-01T09:16:00",
                                    "StatusMatricula":"INATIVO",
                                    "SituacaoAluno":"Egresso",
                                    "Polo":14
			}
		],
                                "Cursos":[
		        {
                                "CursoID":18,
                                "Curso":"Business Intelligence",
                                "TotalVagas":50,
                                "VagasUsadas":30
                                
                        },
			{
                                "CursoID":34,
                                "Curso":"Calculadora HP12C",
                                "TotalVagas":25,
                                "VagasUsadas":25
                                                                   
			}
		]
}

Pesquisa

Retorna uma lista de polos que obedeçam ao critério de pesquisa informado. O parâmetro informado pode ser o nome ou parte do nome do polo. O número de registros é limitado, verifique no header a quantidade de registros e paginação.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/polo/search/{termo da pesquisa}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/polo/search/{termo da pesquisa}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/polo/search/centr

Response

[
    {	
                                "Id":34,
                                "Nome":"Região Central",
                                "Status":"ATIVO"
    },    
    {	
                                "Id":2,
                                "Nome":"Centro-Sul",
                                "Status":"ATIVO"
    }
]

Matrícula

Informações básicas para realizar a matrícula de um aluno pré-cadastrado em um curso.

Estrutura

Campo Descrição Tipo Obrigatório
CadastroId Id do Cadastro Int Sim
CursoId Id do Curso Int Sim
PoloId Id do Polo Int Não

Inclusão

Por meio desta requisição é possível matricular um aluno em um curso da instituição e vincular o aluno a um polo.

A matrícula a um polo esta condicionada ao polo ter vagas disponiveis no curso/polo informado.

Não é obrigatório informar o polo na matricula do aluno.

POST Produção https://api{seudominio}.eadsimples.com.br/v1/matricula/add
POST Sandbox https://apisandbox.eadsimples.com.br/v1/matricula/add

Exemplo de requisição de inclusão sem polo
https://apisandbox.eadsimples.com.br/v1/matricula/add

{
    "CadastroID":6557,
    "CursoID":71
}

Response


    {
        "Id":6557,
        "Nome":"Maria da Silva",
        "CPF":"",
        "Email":"[email protected]",
        "Login":"maria.silva",
        "Status":"ATIVO",
        "IDExterno":"COL01087",
        "ObsAluno":"Estagiária",
        "Matriculas":[
                        {
                            "CadastroId":6557,
                            "CursoId":71,
                            "Curso":"Empreendedorismo",
                            "DataMatricula":"2022-08-11T16:37:00",
                            "DataAcesso":"2023-08-11T16:37:00",
                            "StatusMatricula":"ATIVO",
                            "SituacaoAluno":"Cursando",
                            "PoloID":0
                        }
                    ]
                                           
    }

Exemplo de requisição de inclusão com polo
https://apisandbox.eadsimples.com.br/v1/matricula/add

{
    "CadastroID":6557,
    "CursoID":71,
    "PoloID":14
}

Response


    {
        "Id":6557,
        "Nome":"Maria da Silva",
        "CPF":"",
        "Email":"[email protected]",
        "Login":"maria.silva",
        "Status":"ATIVO",
        "IDExterno":"COL01087",
        "ObsAluno":"Estagiária",
        "Matriculas":[
                        {
                                "CadastroId":6557,
                                "CursoId":71,
                                "Curso":"Empreendedorismo",
                                "DataMatricula":"2022-08-11T16:37:00",
                                "DataAcesso":"2023-08-11T16:37:00",
                                "StatusMatricula":"ATIVO",
                                "SituacaoAluno":"Cursando"
                                "PoloID":14
                        }
                    ]
                                           
    }

Bloqueio

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.

POST Produção https://api{seudominio}.eadsimples.com.br/v1/matricula/disable/
POST Sandbox https://apisandbox.eadsimples.com.br/v1/matricula/disable/

Exemplo de requisição de inativação
https://apisandbox.eadsimples.com.br/v1/matricula/disable/

{
    "CadastroID":6557,
    "CursoID":71
}

Response


    {
        "Id":6557,
        "Nome":"Maria da Silva",
        "CPF":"",
        "Email":"[email protected]",
        "Login":"maria.silva",
        "Status":"ATIVO",
        "IDExterno":"COL01087",
        "ObsAluno":"Estagiária",
        "Matriculas":[
                        {
                            "CadastroId":6557,
                            "CursoId":71,
                            "Curso":"Empreendedorismo",
                            "DataMatricula":"2022-08-11T16:37:00",
                            "DataAcesso":"2023-08-11T16:37:00",
                            "StatusMatricula":"ATIVO",
                            "SituacaoAluno":"Bloqueado"
                        }
                    ]
                                           
    }

Desbloqueio

Através desta requisição é possível desbloquear o acesso ao curso de um aluno já matriculado.

POST Produção https://api{seudominio}.eadsimples.com.br/v1/matricula/activate/
POST Sandbox https://apisandbox.eadsimples.com.br/v1/matricula/activate/

Exemplo de requisição de desbloqueio
https://apisandbox.eadsimples.com.br/v1/matricula/activate/

{
    "CadastroID":6557,
    "CursoID":71
}

Response


    {
        "Id":6557,
        "Nome":"Maria da Silva",
        "CPF":"",
        "Email":"[email protected]",
        "Login":"maria.silva",
        "Status":"ATIVO",
        "IDExterno":"COL01087",
        "ObsAluno":"Estagiária",
        "Matriculas":[
                        {
                            "CadastroId":6557,
                            "CursoId":71,
                            "Curso":"Empreendedorismo",
                            "DataMatricula":"2022-08-11T16:37:00",
                            "DataAcesso":"2023-08-11T16:37:00",
                            "StatusMatricula":"ATIVO",
                            "SituacaoAluno":"Cursando"
                        }
                    ]
                                           
    }

Progresso do Aluno

Dados somente para consulta a fim de obter informações de progresso do aluno no curso.

As informações são atualizadas uma vez por dia, sendo assim não refletem o progresso do aluno em tempo real.

Estrutura

Campo Descrição Tipo Obrigatório
CursoId Id do Curso Int Não
Curso Nome do Curso String(100) Não
PoloId Id do Polo Int Não
Polo Nome do Polo String(100) Não
MatriculaId Id da Matrícula Int Não
Nome Nome do Aluno String(100) Não
CPF CPF do Aluno String(15) Não
Email Email do Aluno String(100) Não
StatusMatricula Status da Matrícula do Aluno (Cursando, Não Aprovado e Expirado, Bloqueado, Aguardando Aceite, Rejeitado Aceite, Aprovado Com Acesso, Aprovado Sem Acesso, Cancelado) String(20) Não
IDExterno Identificador do cadastro no lado do cliente String(100) Não
DataMatricula Data da Matrícula DateTime Não
DataLimiteAcesso Data Limite de Acesso ao Curso DateTime Não
DataConclusao Data de Conclusão do Curso DateTime Não
DatasAcesso Objeto do tipo Lista< DateTime > - Lista todas as datas de acesso do aluno ao curso Lista< DateTime > Não
Media Média obtida pelo Aluno no Curso Decimal Não
ProgressoPercentual Percentual de Progresso do Aluno no Curso Decimal Não
VisualizacaoPercentual Percentual de Visualização do Conteúdo do Curso Decimal Não
DataAtualizacao Data que as informações foram atualizadas DateTime Não

Consulta por ID

Retorna as informações de progresso dos alunos em um curso específico.

Obrigatório informar o ID do Curso para obter os dados dos alunos matriculados.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/aluno/get/{Id}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/aluno/get/{Id}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/aluno/get/14

Response

{
    "CursoID":18,
    "Curso":"Business Intelligence",
    "PoloID":14,
    "Polo":"Plataforma",
    "CadastroID":270, 
    "Nome":"Joao da Silva",
    "CPF":"11111111111",
    "Email":"[email protected]",
    "StatusMatricula":"Cursando",
    "IDExterno":"MAT123",
    "DataMatricula":"2023-01-09T08:10:00",
    "DataLimiteAcesso":"2023-11-09T08:10:00",
    "DataConclusao":,
    "ProgressoPercentual":28.0,
    "VisualizadoPercentual":35.0,
    "DataAtualizacao":"2023-10-19T08:10:00",
    "DatasAcesso":[
                    {
                        "2023-01-09T00:00:00",
                        "2023-01-10T00:00:00",
                        "2023-01-11T00:00:00",
                        "2023-01-12T00:00:00",
                        "2023-01-13T00:00:00",
                        "2023-01-14T00:00:00",
                        "2023-01-15T00:00:00",
                        "2023-01-17T00:00:00"
                    }
                ]
}

Pesquisa

Retorna uma lista de cursos que obedeçam ao critério de pesquisa informado. O parâmetro informado pode ser o nome ou parte do nome do curso.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/curso/search/{termo da pesquisa}
GET Sandbox https://apisandbox.eadsimples.com.br/v1/curso/search/{termo da pesquisa}

Exemplo de requisição de consulta
https://apisandbox.eadsimples.com.br/v1/curso/search/básica

Response

[
    {	
                                "Id":56,
                                "Nome":"Curso Mecânica Básica"
    },    
    {	
                                "Id":106,
                                "Nome":"Física Básica"
    },
    {	
                                "Id":87,
                                "Nome":"Matemática Financeira Básica"
    },
]

Venda

Informações de vendas realizadas de um período.

Estrutura

Campo Descrição Tipo Valores Possíveis
VendaId Id da Venda Int -
Data Data da Venda DateTime -
ValorVenda Valor da Venda Decimal -
Nome Nome do Aluno String -
Status Status da Venda String Aberta, Cancelada, Fechada Aguardando Aprovação, Contestação, Renegociado
Item 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.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/venda/search
GET Sandbox https://apisandbox.eadsimples.com.br/v1/venda/search

Exemplo de requisição de pesquisa
https://apisandbox.eadsimples.com.br/v1/venda/search/?startDate=01/01/2020&endDate=31/01/2020&status=

Response

[
    {
        "VendaId":4101,
        "Data":"2022-01-11T10:03:00",
        "ValorVenda":150.00,
        "CadastroID":3918,
        "Nome":"Agatha Giovana Costa",
        "Status":"Aberta",
        "Item":[
                    {
                        "ItemId":4285,
                        "Combo":"Pacote Promocional com 2 Cursos",
                        "CursoID":106,
                        "Curso":"Física Básica"    
                    },
                    {
                        "ItemId":4285,
                        "Combo":"Pacote Promocional com 2 Cursos",
                        "CursoID":87,
                        "Curso":"Matemática Financeira Básica"    
                    }
                ]
    },
    {
        "VendaId":4136,
        "Data":"2022-01-18T10:57:00",
        "ValorVenda":99.89,
        "CadastroID":3930,
        "Nome":"Guilherme Lucca Ribeiro",
        "Status":"Fechada",
        "Item":[
                    {
                        "ItemId":4613,
                        "Combo":"Aprenda Física",
                        "CursoID":106,
                        "Curso":"Física Básica"    
                    }
                ]
    },
    {
        "VendaId":4437,
        "Data":"2022-05-17T10:59:00",
        "ValorVenda":0.00,
        "CadastroID":4007,
        "Nome":"Erick Arthur Manuel Martins",
        "Status":"Fechada",
        "Item":[
                    {
                        "ItemId":4620,
                        "Combo":"Degustacao",
                        "CursoID":109,
                        "Curso":"Aula Grátis - Demonstração da Didática"    
                    }
                ]
    }
]

Paginação e Filtros

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
status Status da Venda String Não Valores aceitos: Pendente, Pago, Cancelado, Estorno, Reembolso, Concluido
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 -
Exemplo do header com as informações de paginação

Para obter os resultados de uma página específica passe os parâmetros na requisição.

GET Produção https://api{seudominio}.eadsimples.com.br/v1/venda/search?pageNumber=2&pageSize=50&startDate=01/01/2020&endDate=31/01/2020&status=
GET https://apisandbox.eadsimples.com.br/v1/venda/search?pageNumber=2&pageSize=50&startDate=01/01/2020&endDate=31/01/2020&status=

Erros

Quando ocorre um erro na requisição da API, o servidor irá retornar o código 400 ou 500, a depender do tipo de erro.

Lista de Erros

Abaixo o retorno das mensagens de erro

# Erro Classe Requisição Causa
400 Você não possui permissão para realizar esta ação Todas Todas Seu usuário não possui permissão para realizar determinada ação. Consulte o suporte para verificar quais as permissões concedidas.
400 Id inválido Cadastro/Curso/Polo Get/Remove Foi informado um ID não numérico
400 Nome obrigatório Cadastro Add/Remove Não foi informado um nome no cadastro
400 CPF inválido Cadastro Add Foi informado um CPF inválido
400 Email obrigatório Cadastro Add Não foi informado um e-mail no cadastro
400 Email inválido Cadastro Add Foi informado um e-mail inválido
400 Tamanho mínimo da senha de 6 caracteres Cadastro Add Foi informado uma senha com menos de 6 caracteres
400 CPF já cadastrado Cadastro Add Foi informado um CPF que já está na base de alunos. Verifique o cadastro usando a requisição de pesquisa.
400 Login já cadastrado Cadastro Add Foi informado um e-mail que já está na base de alunos. Verifique o cadastro usando a requisição de pesquisa.
400 Cadastro não encontrado Cadastro/Matricula Add/Update/Activate/Disable/Login Foi informado um ID de cadastro que não foi encontrado na base de alunos. Verifique o cadastro usando a requisição de consulta por ID.
500 Erro ao cadastrar Cadastro Add Não foi possível realizar o cadastro. Entre em contato com o suporte.
400 Curso não encontrado Matricula Add/Remove Foi informado um ID de curso que não foi encontrado na base de cursos. Verifique o curso usando a requisição de consulta por ID.
400 Já existe matrícula Matricula Add Foi feita uma tentativa de matricular um aluno que já está inscrito no curso. Verifique a matrícula do aluno usando a requisição de consulta por ID.
400 Polo não possui vagas disponíveis Matricula Add Não foi possível matricular o aluno pois o polo não possui vagas disponíveis. Aumente o número de vagas disponíveis no polo através do painel administrador da plataforma.
400 Polo não encontrado Matricula Add Não foi possível matricular o aluno, o ID do polo informado não foi encontrado. Verifique se o ID do polo está correto.
400 Matrícula não encontrada Matricula Remove Não foi encontrado a matrícula a ser removida.
400 Data de início inválida. O formato deve ser 'dd/mm/aaaa' Venda Search Verifique se a data informada está no formato dd/mm/aaaa.
400 Data final inválida. O formato deve ser 'dd/mm/aaaa' Venda Search Verifique se a data informada está no formato dd/mm/aaaa.
400 Período inválido Venda Search A data final é inferior a data inicial de consulta.
500 Erro ao matricular Matricula Add Não foi possível realizar a matrícula. Entre em contato com o suporte.
500 Erro ao bloquear a matrícula Matricula Disable Não foi possível bloquear a matrícula. Verifique se a matrícula e o cadastro do aluno estão ativos.
500 Erro ao desbloquear a matrícula Matricula Activate Não foi possível desbloquear a matrícula. Verifique se a matrícula já está ativa.
500 Ocorreu um erro ao inserir o cadastro Cadastro Add/Update Não foi possível inserir ou alterar o cadastro. Entre em contato com o suporte.