_edited.png){kind=small}
🟢 Você está logado
INTRODUÇÃO
Apresentação da API
A API PreparaEdu oferece um conjunto de endpoints RESTful para que sistemas de ensino e aplicações acadêmicas possam autenticar usuários, gerenciar testes, questões, respostas de alunos, coordenadores, docentes e demais perfis de acesso de forma simples e segura. Com ela, é possível:
-
Autenticar aplicadores e obter um token de acesso que garante segurança em todas as chamadas subsequentes.
-
Listar e cadastrar testes (provas, simulados e avaliações), incluindo metadados como código, título, cursos, tipo de teste, número de questões objetivas e discursivas, status (ativo/arquivado) e informações do aplicador responsável.
-
Consultar resultados de testes em andamento ou finalizados, detalhando médias, faixas ENADE, número de participantes, tempo de execução, agendamentos e violações de regras.
-
Recuperar perguntas de um teste específico, com enunciados, base de texto, tipologia, alternativas e níveis de dificuldade.
-
Listar e gerenciar perfis de coordenadores, docentes, gestores e alunos, incluindo dados de contato e data de criação de registro.
-
Registrar novos alunos diretamente pela API, permitindo alimentar sua base de usuários com informações de nome, RA, CPF, e-mail e foto de perfil.
Toda requisição, após a autenticação inicial, deve incluir o token JWT no corpo da chamada para validação de segurança. A documentação detalha para cada endpoint o método HTTP, a estrutura de request/response em JSON, exemplos de cURL e de chamadas em JavaScript.
Com a API PreparaEdu, sua aplicação ganha autonomia para criar fluxos de avaliação completos — desde a distribuição de simulados até a análise de desempenho dos estudantes — mantendo consistência de dados e garantindo uma experiência integrada e escalável.
CICLO DE UTILIZAÇÃO
A primeira solicitação é a autenticação... o uso do token será necessário em todas as demais.
LISTA DE SOLICITAÇÕES
Autenticação
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/autenticar' \
--header 'Content-Type: application/json' \
--data '{
"email": "-",
"palavra_passe": "-"
}'
Javascript
var data = JSON.stringify({
"email": "-",
"palavra_passe": "-"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/autenticar");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"email": "user@mail.com",
"palavra_passe": "#########"
}
Reponse
{
"token": "eyJraWQiOiJQSXpvZGJiQiIsImFsZyI6IkhTMjU2In0.eyJkYXRhIjoie1wiaWRcIjpcImFkNTMyOGIzLTkyZDAtNDkzYy1hZDQ4LWRhMTQxNjBhNDlkZlwiLFwiY29sbGVjdGlvmItOWUyNS0zODVkOTk1MTAyZWRcIixcIm1ldGFTaXRlSWRcIjpcImU3N2VlNTIxLTFhYjEtNGFlNC1iMzI4LWVmNTlkMjQ4ZmQ1N1wiLFwib3duZXJcIjpmYWxzZSxcImNyZWF0aW9uVGltZVwiOjE3NDc2ODk0NzY2MDQsXCJleHBpcmVzSW5cIjoxMjA5NjAwMDAwLFwiZXhwaXJhdGlvblRpbWVcIjoxNzQ3Njg5NTM2NjIxLFwibGFzdFJlZnJlc2hlZFwiOjAsXCJhZG1pblwiOnRydWUsXCJzZXNzaW9uSWRcIjpcImYyMjRhMTdhLTJkM2QtNGM4Mi04ZmE2LWUyNWFiNGY5MDBhNlwiLFwiY29udGFjdElkXCI6XCJhZDUzMjhiMy05MmQwLTQ5M2MtYWQ0OC1kYTE0MTYwYTQ5ZGZcIn0iLCJpYXQiOjE3NDc2ODk0NzZ9.sSx2jCX1ySnSTDkGubMTfutNn6bGpU_nyg8rgsm_rJo",
"validade": "2025-05-20T20:37:40.093Z"
}
Listar Testes
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_testes' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_testes");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"testes": [
{
"codigo": "DIR-25-06-A12",
"titulo": "Avaliação de Direito Civil",
"cursos": "Direito",
"ativo": "Sim",
"total_de_questoes": 30,
"total_de_questoes_de_formacao_geral": 10,
"total_de_questoes_de_conhecimento_especifico": 18,
"total_de_questoes_discursivas": 2,
"arquivado": "Não",
"tipo_de_teste": "Avaliação Parcial",
"aplicador": {
"nome": "Prof. Carlos Mendes",
"email": "carlos.mendes@faculdade.edu",
"telefone": "(11) 98765-4321"
},
"data_de_criacao_do_registro": "6/10/2025",
"_id": "a1b2c3d4-e5f6-7890"
},
{
"codigo": "MED-25-06-B34",
"titulo": "Prova de Anatomia",
"cursos": "Medicina",
"ativo": "Sim",
"total_de_questoes": 40,
"total_de_questoes_de_formacao_geral": 0,
"total_de_questoes_de_conhecimento_especifico": 38,
"total_de_questoes_discursivas": 2,
"arquivado": "Não",
"tipo_de_teste": "Prova Bimestral",
"aplicador": {
"nome": "Dra. Ana Beatriz",
"email": "ana.beatriz@faculdade.edu",
"telefone": "(21) 99876-5432"
},
"data_de_criacao_do_registro": "6/05/2025",
"_id": "b2c3d4e5-f6a7-8901"
},
{
"codigo": "ADM-25-06-C56",
"titulo": "Simulado de Gestão",
"cursos": "Administração",
"ativo": "Não",
"total_de_questoes": 20,
"total_de_questoes_de_formacao_geral": 5,
"total_de_questoes_de_conhecimento_especifico": 14,
"total_de_questoes_discursivas": 1,
"arquivado": "Sim",
"tipo_de_teste": "Simulado",
"aplicador": {
"nome": "Prof. Roberto Alves",
"email": "roberto.alves@faculdade.edu",
"telefone": "(31) 98765-1234"
},
"data_de_criacao_do_registro": "5/22/2025",
"_id": "c3d4e5f6-a7b8-9012"
},
{
"codigo": "ENG-25-05-D78",
"titulo": "Teste de Cálculo II",
"cursos": "Engenharia",
"ativo": "Sim",
"total_de_questoes": 15,
"total_de_questoes_de_formacao_geral": 0,
"total_de_questoes_de_conhecimento_especifico": 12,
"total_de_questoes_discursivas": 3,
"arquivado": "Não",
"tipo_de_teste": "Teste",
"aplicador": {
"nome": "Prof. Fernando Costa",
"email": "fernando.costa@faculdade.edu",
"telefone": "(41) 99876-4321"
},
"data_de_criacao_do_registro": "5/15/2025",
"_id": "d4e5f6a7-b8c9-0123"
},
{
"codigo": "PSI-25-05-E90",
"titulo": "Questionário de Psicologia Social",
"cursos": "Psicologia",
"ativo": "Não",
"total_de_questoes": 10,
"total_de_questoes_de_formacao_geral": 2,
"total_de_questoes_de_conhecimento_especifico": 8,
"total_de_questoes_discursivas": 0,
"arquivado": "Não",
"tipo_de_teste": "Questionário",
"aplicador": {
"nome": "Profa. Juliana Martins",
"email": "juliana.martins@faculdade.edu",
"telefone": "(51) 98765-6789"
},
"data_de_criacao_do_registro": "5/08/2025",
"_id": "e5f6a7b8-c9d0-1234"
}
],
"numero_de_registros": 5
}
Listar Coordenadores
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_coordenadores' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_coordenadores");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"coordenadores": [
{
"nome": "COORDENADOR 0001",
"email": "coordenador0001@escola.edu.br",
"telefone": "(00) 00000-0001",
"cursos": [
"Curso 001"
],
"data_de_criacao_do_registro": "01/01/2024",
"_id": "00000000-0000-0000-0000-000000000001"
},
{
"nome": "COORDENADOR 0002",
"email": "coordenador0002@escola.edu.br",
"telefone": "(00) 00000-0002",
"cursos": [
"Curso 002"
],
"data_de_criacao_do_registro": "02/01/2024",
"_id": "00000000-0000-0000-0000-000000000002"
},
{
"nome": "COORDENADOR 0003",
"email": "coordenador0003@escola.edu.br",
"telefone": "(00) 00000-0003",
"cursos": [
"Curso 003",
"Curso 004"
],
"data_de_criacao_do_registro": "03/01/2024",
"_id": "00000000-0000-0000-0000-000000000003"
},
{
"nome": "COORDENADOR 0004",
"email": "coordenador0004@escola.edu.br",
"telefone": "(00) 00000-0004",
"cursos": [
"Curso 005"
],
"data_de_criacao_do_registro": "04/01/2024",
"_id": "00000000-0000-0000-0000-000000000004"
},
{
"nome": "COORDENADOR 0005",
"email": "coordenador0005@escola.edu.br",
"telefone": "(00) 00000-0005",
"cursos": [
"Curso 006"
],
"data_de_criacao_do_registro": "05/01/2024",
"_id": "00000000-0000-0000-0000-000000000005"
}
],
"numero_de_registros": 5
}
Listar Respostas de Alunos
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_respostas_dos_alunos_no_teste' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN",
"id_do_resultado": "da67ddc1-e8a0-437b-bd7a-b4479e0470d6"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN",
"id_do_resultado": "da67ddc1-e8a0-437b-bd7a-b4479e0470d6"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_respostas_dos_alunos_no_teste");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO",
"id_do_resultado": "ID DO RESULTADO"
}
Reponse
{
"respostas": [
{
"nome_do_aluno": "Nome do Aluno 1",
"email_do_aluno": "aluno1@email.com",
"respostas_e_gabaritos": {
"1": {
"curso": "Curso A",
"discursivaCorrigida": false,
"questao": 1,
"notaDiscursiva": 0,
"tipoDeQuestao": "Objetiva",
"correta": false,
"gabarito": "A",
"pergunta": "uuid-q1",
"resposta": "B"
},
"2": {
"curso": "Curso A",
"discursivaCorrigida": false,
"questao": 2,
"notaDiscursiva": 0,
"tipoDeQuestao": "Objetiva",
"correta": true,
"gabarito": "C",
"pergunta": "uuid-q2",
"resposta": "C"
},
"3": {
"curso": "Curso A",
"discursivaCorrigida": false,
"questao": 3,
"notaDiscursiva": 0,
"tipoDeQuestao": "Objetiva",
"correta": false,
"gabarito": "D",
"pergunta": "uuid-q3",
"resposta": "A"
}
},
"sala": "SALA001",
"data_de_criacao_do_registro": "2025-01-01",
"_id": "uuid-aluno1"
},
{
"nome_do_aluno": "Nome do Aluno 2",
"email_do_aluno": "aluno2@email.com",
"respostas_e_gabaritos": {
"1": {
"curso": "Curso B",
"discursivaCorrigida": false,
"questao": 1,
"notaDiscursiva": 0,
"tipoDeQuestao": "Objetiva",
"correta": true,
"gabarito": "B",
"pergunta": "uuid-q1",
"resposta": "B"
},
"2": {
"curso": "Curso B",
"discursivaCorrigida": false,
"questao": 2,
"notaDiscursiva": 0,
"tipoDeQuestao": "Objetiva",
"correta": false,
"gabarito": "A",
"pergunta": "uuid-q2",
"resposta": "D"
},
"3": {
"curso": "Curso B",
"discursivaCorrigida": false,
"questao": 3,
"notaDiscursiva": 0,
"tipoDeQuestao": "Objetiva",
"correta": true,
"gabarito": "C",
"pergunta": "uuid-q3",
"resposta": "C"
}
},
"sala": "SALA002",
"data_de_criacao_do_registro": "2025-01-01",
"_id": "uuid-aluno2"
}
]
}
Listar Perguntas
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_perguntas' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN",
"id_do_teste":"ID DE UM TESTE"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN",
"id_do_teste": "ddef8eba-d707-470c-afe3-756d5f1bcff6"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_perguntas");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO",
"id_do_teste":"ID DE UM TESTE"
}
Reponse
{
"perguntas": [
{
"texto_base": "A transformação digital nas empresas tem revolucionado os modelos de negócio, exigindo novas competências dos profissionais. A adaptação a essas mudanças requer tanto capacitação técnica quanto desenvolvimento de habilidades socioemocionais.",
"enunciado": "Analise os impactos da transformação digital no mercado de trabalho, abordando as novas exigências para os profissionais e as estratégias de adaptação necessárias.",
"tipo_de_item": "Discursiva",
"alternativa_a": "-",
"alternativa_b": "-",
"alternativa_c": "-",
"alternativa_d": "-",
"alternativa_e": "-",
"gabarito": "-",
"nivel": "Médio",
"imagem": "",
"curso": "Administração",
"taxa_de_acertos_BR": null,
"data_de_criacao_do_registro": "6/15/2025",
"_id": "a1b2c3d4-e5f6-7890"
},
{
"texto_base": "O gráfico apresenta a evolução do PIB brasileiro nos últimos 5 anos, com destaque para os setores que mais cresceram.",
"enunciado": "Considerando os dados apresentados, avalie as afirmações: I - O setor de serviços foi o que apresentou maior crescimento no período; II - A indústria teve desempenho superior à média nacional; III - O agronegócio foi o único setor que não sofreu queda em nenhum ano. É correto o que se afirma em:",
"tipo_de_item": "Resposta Múltipla",
"alternativa_a": "I, apenas",
"alternativa_b": "III, apenas",
"alternativa_c": "I e II, apenas",
"alternativa_d": "II e III, apenas",
"alternativa_e": "I, II e III",
"gabarito": "B",
"nivel": "Difícil",
"imagem": "https://exemplo.com/grafico-pib.jpg",
"curso": "Economia",
"taxa_de_acertos_BR": "38%",
"data_de_criacao_do_registro": "6/10/2025",
"_id": "b2c3d4e5-f6a7-8901"
},
{
"texto_base": "A LGPD (Lei Geral de Proteção de Dados) estabelece normas sobre coleta, armazenamento e tratamento de dados pessoais.",
"enunciado": "Uma empresa que deseja estar em conformidade com a LGPD deve:",
"tipo_de_item": "Complementação Simples",
"alternativa_a": "Coletar o máximo de dados possível para melhorar seus serviços",
"alternativa_b": "Nomear um encarregado de proteção de dados",
"alternativa_c": "Armazenar os dados indefinidamente para segurança jurídica",
"alternativa_d": "Compartilhar dados com parceiros sem consentimento explícito",
"alternativa_e": "Priorizar a segurança de dados apenas de clientes premium",
"gabarito": "B",
"nivel": "Médio",
"imagem": "",
"curso": "Direito",
"taxa_de_acertos_BR": "65%",
"data_de_criacao_do_registro": "6/5/2025",
"_id": "c3d4e5f6-a7b8-9012"
}
],
"numero_de_registros": 3
}
Listar Docentes
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_docentes' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_docentes");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"docentes": [
{
"nome": "DOCENTE 0001",
"email": "docente0001@escola.edu.br",
"telefone": "(00) 00000-0001",
"data_de_criacao_do_registro": "01/01/2024",
"_id": "00000000-0000-0000-0000-000000000001"
},
{
"nome": "DOCENTE 0002",
"email": "docente0002@escola.edu.br",
"telefone": "(00) 00000-0002",
"data_de_criacao_do_registro": "02/01/2024",
"_id": "00000000-0000-0000-0000-000000000002"
},
{
"nome": "DOCENTE 0003",
"email": "docente0003@escola.edu.br",
"telefone": "(00) 00000-0003",
"data_de_criacao_do_registro": "03/01/2024",
"_id": "00000000-0000-0000-0000-000000000003"
},
{
"nome": "DOCENTE 0004",
"email": "docente0004@escola.edu.br",
"telefone": "(00) 00000-0004",
"data_de_criacao_do_registro": "04/01/2024",
"_id": "00000000-0000-0000-0000-000000000004"
},
{
"nome": "DOCENTE 0005",
"email": "docente0005@escola.edu.br",
"telefone": "(00) 00000-0005",
"data_de_criacao_do_registro": "05/01/2024",
"_id": "00000000-0000-0000-0000-000000000005"
}
],
"numero_de_registros": 5
}
Logar
POST
Deixar claro que a redirect_url retornada pode ser usada para acessar o sistema PREPARAEDU
cURL
curl --location 'https://preparaedu.com.br/_functions/logar' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "email@dominio.com",
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"email": "email@dominio.com",
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/logar");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO",
"email": "email@dominio.com"
}
Listar Resultados
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_resultados_de_testes' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_resultados_de_testes");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"resultados": [
{
"sala": "SALA01",
"titulo": "Curso A - Avaliação",
"em_andamento": "Sim",
"agendado": "Sim",
"tempo_de_vencimento": null,
"inicio_do_teste": "02/14/2025",
"final_do_teste": "03/12/2025",
"tempo_transcorrido": "12:00:00",
"vencimento": "03/31/2025 04:00:00",
"finalizado": "Sim",
"media": 61.5,
"media_de_formacao_geral": 0,
"media_de_conhecimento_especifico": 61.5,
"total_de_questoes": 31,
"total_de_redacoes": 1,
"total_de_questoes_de_formacao_geral": 0,
"total_de_questoes_de_conhecimento_especifico": 30,
"total_de_alunos_participantes": 18,
"total_de_alunos_que_abandonaram": 0,
"tota_de_alunos_que_finalizaram": 16,
"curso": "Curso A",
"faixa_enade": 3,
"questoes_randomicas": "Não",
"sem_consulta": "Não",
"limite_de_execucao": "Não",
"limite_de_execucao_do_teste_em_minutos": 0,
"aplicador": {
"nome": "Aplicador 1",
"email": "aplicador1@email.com",
"telefone": ""
},
"data_de_criacao_do_registro": "02/14/2025",
"_id": "ID001"
},
{
"sala": "SALA02",
"titulo": "Curso B - Simulado",
"em_andamento": "Sim",
"agendado": "Não",
"inicio_do_teste": "03/29/2023",
"final_do_teste": "09/11/2023",
"tempo_transcorrido": "04:00:00",
"vencimento": "03/29/2023 04:11:11",
"finalizado": "Sim",
"media": 35.3,
"media_de_formacao_geral": 25.3,
"media_de_conhecimento_especifico": 38.6,
"total_de_questoes": 20,
"total_de_redacoes": 0,
"total_de_questoes_de_formacao_geral": 5,
"total_de_questoes_de_conhecimento_especifico": 15,
"total_de_alunos_participantes": 15,
"total_de_alunos_que_abandonaram": 0,
"tota_de_alunos_que_finalizaram": 15,
"curso": "Curso B",
"faixa_enade": 1,
"questoes_randomicas": "Não",
"sem_consulta": "Não",
"limite_de_execucao": "Não",
"aplicador": {
"nome": "Aplicador 2",
"email": "aplicador2@email.com"
},
"data_de_criacao_do_registro": "03/29/2023",
"_id": "ID002"
},
{
"sala": "SALA03",
"titulo": "Curso C - Simulado",
"em_andamento": "Sim",
"agendado": "Sim",
"tempo_de_vencimento": null,
"inicio_do_teste": "05/06/2025",
"final_do_teste": "05/07/2025",
"tempo_transcorrido": "01:00:00",
"vencimento": "05/07/2025 02:00:00",
"finalizado": "Sim",
"media": 49.9,
"media_de_formacao_geral": 52.9,
"media_de_conhecimento_especifico": 48.9,
"total_de_questoes": 26,
"total_de_redacoes": 1,
"total_de_questoes_de_formacao_geral": 5,
"total_de_questoes_de_conhecimento_especifico": 20,
"total_de_alunos_participantes": 15,
"total_de_alunos_que_abandonaram": 0,
"tota_de_alunos_que_finalizaram": 14,
"curso": "Curso C",
"faixa_enade": 1,
"questoes_randomicas": "Sim",
"sem_consulta": "Sim",
"limite_de_execucao": "Não",
"limite_de_execucao_do_teste_em_minutos": 0,
"aplicador": {
"nome": "Aplicador 3",
"email": "aplicador3@email.com",
"telefone": "(00) 0000-0000"
},
"data_de_criacao_do_registro": "05/05/2025",
"_id": "ID003"
}
],
"numero_de_registros": 3
}
Cadastrar Aluno
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/cadastrar_aluno' \
--header 'Content-Type: application/json' \
--data-raw '{
"nome":"Carlos",
"sobrenome":"Costa",
"instituicao":"PREPARAEDU",
"cpf":"000.000.000-10",
"email": "carlos0004@mail.com",
"foto":"https://avatar.iran.liara.run/public/10",
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"nome": "Carlos",
"sobrenome": "Costa",
"instituicao": "PREPARAEDU",
"cpf": "000.000.000-10",
"email": "carlos0004@mail.com",
"foto": "https://avatar.iran.liara.run/public/10",
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/cadastrar_aluno");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"nome":"Carlos",
"sobrenome":"Costa",
"instituicao":"PREPARAEDU",
"cpf":"000.000.000-10",
"email": "carlos0003@mail.com",
"foto":"https://avatar.iran.liara.run/public/10",//-------------OPCIONAL
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"status": "ok"
}
Listar Resultados de Alunos
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_resultados_dos_alunos_no_teste' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN",
"id_do_resultado": "ID DE UM RESULTADO"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN",
"id_do_resultado": "ID DE UM RESULTADO"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_resultados_dos_alunos_no_teste");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO",
"id_do_resultado": "ID DO RESULTADO"
}
Reponse
{
"resultados": [
{
"nome_do_aluno": "Nome do Aluno 1",
"email_do_aluno": "aluno1@email.com",
"acertos": 12,
"erros": 14,
"acertos_em_questoes_de_formacao_geral": 3,
"acertos_em_questoes_de_conhecimento_especifico": 9,
"quantidade_de_questoes_de_formacao_geral": 5,
"quantidade_de_questoes_de_conhecimento_especifico": 20,
"quantidade_de_questoes_discursivas": 1,
"quantidade_de_questoes_respondidas": 26,
"total_de_questoes_do_teste": 26,
"teste_foi_concluido": "Sim",
"status_no_teste": "Finalizado",
"media": 46.2,
"sala": "SALA001",
"teste_finalizado_por_violacao_de_regras": "Não",
"teste_iniciado": "5/8/2025 10:00:00 PM",
"tempo_para_conclusao_em_minutos": 45,
"abandonou_o_teste": "Não",
"questao_discursiva_corrigida": "Não",
"nota_da_questao_discursiva": 0,
"feedback_da_questao_discursiva": "",
"data_de_criacao_do_registro": "5/8/2025",
"_id": "uuid-aluno1"
},
{
"nome_do_aluno": "Nome do Aluno 2",
"email_do_aluno": "aluno2@email.com",
"acertos": 17,
"erros": 9,
"acertos_em_questoes_de_formacao_geral": 5,
"acertos_em_questoes_de_conhecimento_especifico": 12,
"quantidade_de_questoes_de_formacao_geral": 5,
"quantidade_de_questoes_de_conhecimento_especifico": 20,
"quantidade_de_questoes_discursivas": 1,
"quantidade_de_questoes_respondidas": 26,
"total_de_questoes_do_teste": 26,
"teste_foi_concluido": "Sim",
"status_no_teste": "Finalizado",
"media": 65.4,
"sala": "SALA001",
"teste_finalizado_por_violacao_de_regras": "Não",
"teste_iniciado": "5/8/2025 10:30:00 PM",
"tempo_para_conclusao_em_minutos": 50,
"abandonou_o_teste": "Não",
"questao_discursiva_corrigida": "Não",
"nota_da_questao_discursiva": 0,
"feedback_da_questao_discursiva": "",
"data_de_criacao_do_registro": "5/8/2025",
"_id": "uuid-aluno2"
},
{
"nome_do_aluno": "Nome do Aluno 3",
"email_do_aluno": "aluno3@email.com",
"acertos": 9,
"erros": 16,
"acertos_em_questoes_de_formacao_geral": 2,
"acertos_em_questoes_de_conhecimento_especifico": 7,
"quantidade_de_questoes_de_formacao_geral": 5,
"quantidade_de_questoes_de_conhecimento_especifico": 20,
"quantidade_de_questoes_discursivas": 1,
"quantidade_de_questoes_respondidas": 26,
"total_de_questoes_do_teste": 26,
"teste_foi_concluido": "Sim",
"status_no_teste": "Finalizado",
"media": 38.1,
"sala": "SALA001",
"teste_finalizado_por_violacao_de_regras": "Não",
"teste_iniciado": "5/8/2025 11:00:00 PM",
"tempo_para_conclusao_em_minutos": 40,
"abandonou_o_teste": "Não",
"questao_discursiva_corrigida": "Não",
"nota_da_questao_discursiva": 0,
"feedback_da_questao_discursiva": "",
"data_de_criacao_do_registro": "5/8/2025",
"_id": "uuid-aluno3"
}
],
"numero_de_registros": 3
}
Listar Gestores
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_gestores' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_gestores");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"gestores": [
{
"nome": "GESTOR 0001",
"email": "gestor0001@instituicao.edu.br",
"telefone": "(00) 00000-0001",
"data_de_criacao_do_registro": "01/01/2024",
"_id": "00000000-0000-0000-0000-000000000001"
},
{
"nome": "GESTOR 0002",
"email": "gestor0002@instituicao.edu.br",
"telefone": "(00) 00000-0002",
"data_de_criacao_do_registro": "02/01/2024",
"_id": "00000000-0000-0000-0000-000000000002"
},
{
"nome": "GESTOR 0003",
"email": "gestor0003@instituicao.edu.br",
"telefone": "(00) 00000-0003",
"data_de_criacao_do_registro": "03/01/2024",
"_id": "00000000-0000-0000-0000-000000000003"
},
{
"nome": "GESTOR 0004",
"email": "gestor0004@instituicao.edu.br",
"telefone": "(00) 00000-0004",
"data_de_criacao_do_registro": "04/01/2024",
"_id": "00000000-0000-0000-0000-000000000004"
},
{
"nome": "GESTOR 0005",
"email": "gestor0005@instituicao.edu.br",
"telefone": "(00) 00000-0005",
"data_de_criacao_do_registro": "05/01/2024",
"_id": "00000000-0000-0000-0000-000000000005"
}
],
"numero_de_registros": 5
}
Listar Alunos
POST
Sed et egestas lacus, non faucibus nisi. Praesent dapibus erat sit amet ipsum hendrerit posuere. Aenean laoreet facilisis purus eget vestibulum. Pellentesque dapibus vel sem at euismod. Maecenas ultrices, libero in ultrices ornare, dui tellus pellentesque est, in sodales erat arcu vitae lorem. Nulla ac felis luctus, mattis erat tristique, lobortis elit. Nam finibus felis id velit dapibus lobortis. Nam sit amet auctor neque. Vivamus egestas molestie turpis in vestibulum. Fusce blandit enim non ex porta euismod. Nulla facilisi. Integer posuere varius aliquam. Praesent vehicula aliquet dolor malesuada ultricies. Aenean condimentum vestibulum velit.
cURL
curl --location 'https://preparaedu.com.br/_functions/listar_alunos' \
--header 'Content-Type: application/json' \
--data '{
"token": "TOKEN"
}'
Javascript
var data = JSON.stringify({
"token": "TOKEN"
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://preparaedu.com.br/_functions/listar_alunos");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Body
{
"token": "TOKEN RECEBIDO NA AUTENTICAÇÃO"
}
Reponse
{
"alunos": [
{
"nome": "ALUNO 0001",
"email": "aluno0001@escola.edu.br",
"ra": "000.000.001-00",
"data_de_criacao_do_registro": "01/01/2025",
"_id": "00000000-0000-0000-0000-000000000001"
},
{
"nome": "ALUNO 0002",
"email": "aluno0002@escola.edu.br",
"ra": "000.000.002-00",
"data_de_criacao_do_registro": "02/01/2025",
"_id": "00000000-0000-0000-0000-000000000002"
},
{
"nome": "ALUNO 0003",
"email": "aluno0003@escola.edu.br",
"ra": "000.000.003-00",
"data_de_criacao_do_registro": "03/01/2025",
"_id": "00000000-0000-0000-0000-000000000003"
},
{
"nome": "ALUNO 0004",
"email": "aluno0004@escola.edu.br",
"ra": "000.000.004-00",
"data_de_criacao_do_registro": "04/01/2025",
"_id": "00000000-0000-0000-0000-000000000004"
},
{
"nome": "ALUNO 0005",
"email": "aluno0005@escola.edu.br",
"ra": "000.000.005-00",
"data_de_criacao_do_registro": "05/01/2025",
"_id": "00000000-0000-0000-0000-000000000005"
}
],
"numero_de_registros": 5
}