GILLIS INTERACTIVE
  1. Alunos
GILLIS INTERACTIVE
  • Comece aqui
  • Autenticação
    • Criar token
      POST
    • Validar token
      GET
    • Renovar token
      PUT
  • Alunos
    • Listar alunos
      GET
    • Listar aluno pelo ID
      GET
    • Cadastrar aluno
      POST
    • Atualizar aluno
      PUT
    • Deletar aluno
      DELETE
  • Cursos
    • Listar cursos
      GET
    • Curso matriculado
      GET
    • Matricular cursos
      POST
    • Remover cursos
      DELETE
  • Pacotes
    • Listar pacotes
      GET
    • Pacote matriculado
      GET
    • Matricular pacote
      POST
    • Remover pacote
      DELETE
  1. Alunos

Cadastrar aluno

POST
{{BaseURL}}/students

Descrição#

Endpoint para criar um novo aluno no sistema.

📋 Detalhes da Requisição#

URL#

POST https://seudominio.com/api/students

Headers Obrigatórios#

Corpo da Requisição (JSON)#

{
  "nome": "João",
  "sobrenome": "Silva",
  "email": "joao@email.com",
  "usuario": "joaosilva",
  "senha": "minhasenha123",
  "nascimento": "1990-05-15",
  "sexo": "M",
  "cpf": "123.456.789-00",
  "rg": "123.456.789-00",
  "telefone": "99999999999",
  "endereco": "Rua das Flores, 123",
  "cidade": "São Paulo",
  "estado": "SP",
  "pais": "Brasil",
  "cep": "01234-567",
  "tipo": "presencial",
  "nome_responsavel": "Maria Silva",
  "sobrenome_responsavel": "Santos",
  "sexo_responsavel": "F",
  "cpf_responsavel": "987.654.321-00",
  "rg_responsavel": "987.654.321-00",
  "email_responsavel": "maria@email.com",
  "nascimento_responsavel": "1970-03-20",
  "endereco_responsavel": "Rua das Flores, 123",
  "cidade_responsavel": "São Paulo",
  "estado_responsavel": "SP",
  "pais_responsavel": "Brasil",
  "cep_responsavel": "01234-567",
  "contato_responsavel": "99999999999"
}

📤 Respostas da API#

✅ Sucesso (201 Created)#

{
  "success": true,
  "message": "Aluno criado com sucesso",
  "data": {
    "id": 123,
    "nome": "João",
    "sobrenome": "Silva",
    "tipo": "presencial",
    "nascimento": "1990-05-15",
    "...": "..."
  }
}

❌ Erro - Dados Inválidos (400 Bad Request)#

{
  "success": false,
  "message": "Data de nascimento não informada",
  "error": "Bad Request"
}

❌ Erro - Email Duplicado (409 Conflict)#

{
  "success": false,
  "message": "Email do aluno já está sendo utilizado por outro usuário",
  "error": "Conflict"
}

🔍 Campos da Requisição#

Dados Pessoais do Aluno#

CampoTipoObrigatórioDescriçãoExemplo
nomestring✅ SimNome do aluno"João"
sobrenomestring✅ SimSobrenome do aluno"Silva"
emailstring✅ SimEmail do aluno"[email_protected]"
usuariostring✅ SimNome de usuário para login"joaosilva"
senhastring✅ SimSenha (mínimo 7 caracteres)"minhasenha123"
nascimentostring✅ SimData de nascimento (YYYY-MM-DD)"1990-05-15"
sexostring✅ SimSexo (M/F)"M"
tipostring✅ SimTipo de aluno (ead/presencial)"ead"
telefonestring❌ NãoTelefone (DDD+Tel)"99999999999"
enderecostring❌ NãoEndereço"Rua das Flores, 123"
cidadestring❌ NãoCidade"São Paulo"
estadostring❌ NãoEstado (UF)"SP"
paisstring❌ NãoPaís"Brasil"
cepstring❌ NãoCEP"01234-567"
cpfstring❌ NãoCPF (máximo 15 caracteres)"123.456.789-00"
rgstring❌ NãoRG (máximo 15 caracteres)"123.456.789-00"

Dados do Responsável#

CampoTipoObrigatórioDescriçãoExemplo
nome_responsavelstring❌ NãoNome do responsável"Maria Silva"
sobrenome_responsavelstring❌ NãoSobrenome do responsável"Santos"
sexo_responsavelstring❌ NãoSexo do responsável (M/F)"F"
cpf_responsavelstring❌ NãoCPF do responsável"987.654.321-00"
rg_responsavelstring❌ NãoRG do responsável"987.654.321-00"
email_responsavelstring❌ NãoEmail do responsável"[email_protected]"
nascimento_responsavelstring❌ NãoData de nascimento do responsável"1970-03-20"
endereco_responsavelstring❌ NãoEndereço do responsável"Rua das Flores, 123"
cidade_responsavelstring❌ NãoCidade do responsável"São Paulo"
estado_responsavelstring❌ NãoEstado do responsável (UF)"SP"
pais_responsavelstring❌ NãoPaís do responsável"Brasil"
cep_responsavelstring❌ NãoCEP do responsável"01234-567"
contato_responsavelstring❌ NãoTelefone do responsável (DDD+tel)"88888888888"

⚠️ Códigos de Status HTTP#

CódigoDescriçãoQuando Ocorre
201CreatedAluno criado com sucesso
400Bad RequestDados inválidos ou campos obrigatórios faltando
401UnauthorizedToken inválido ou não fornecido
409ConflictEmail ou usuário já cadastrado
500Internal Server ErrorErro interno do servidor

🔍 Principais regras de Validação#

email, email_responsavel: formato válido
senha: mínimo 7 caracteres
rg, rg_responsavel: máximo 15 caracteres
cpf, cpf_responsavel: máximo 15 caracteres
nascimento: deve ser válido (YYYY-MM-DD)
tipo: deve ser "ead" ou "presencial"

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Bodyapplication/jsonNecessário

Exemplo
{
    "nome" : "api2",
    "sobrenome" : "gillis",
    "email" : "apigillis2@gmail.com",
    "cpf" : "",
    "rg" : "",
    "telefone" : "11111111111",
    "endereco" : "Rua sobe e desce",
    "cidade" : "Manaus",
    "estado" : "AM",
    "pais" : "Brasil",
    "cep" : "69099-380",
    "sexo" : "M",
    "usuario" : "apigillis2",
    "senha" : "apigillis123",
    "nascimento" : "2015-03-11",
    "tipo" : "presencial",
    "contato_responsavel" : "11111111111",
    "nome_responsavel" : "respapi",
    "sobrenome_responsavel" : "sobreapi",
    "sexo_responsavel" : "M",
    "cpf_responsavel" : "111.111.111-11",
    "rg_responsavel" : "111.111.111-11",
    "email_responsavel" : "respapi@gmail.com",
    "nascimento_responsavel" : "1990-03-25",
    "cep_responsavel" : "69099-380",
    "cidade_responsavel" : "Manaus",
    "endereco_responsavel" : "Rua sobe e desce",
    "estado_responsavel" : "AM", 
    "pais_responsavel" : "Brasil"
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{BaseURL}}/students' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nome" : "api2",
    "sobrenome" : "gillis",
    "email" : "apigillis2@gmail.com",
    "cpf" : "",
    "rg" : "",
    "telefone" : "11111111111",
    "endereco" : "Rua sobe e desce",
    "cidade" : "Manaus",
    "estado" : "AM",
    "pais" : "Brasil",
    "cep" : "69099-380",
    "sexo" : "M",
    "usuario" : "apigillis2",
    "senha" : "apigillis123",
    "nascimento" : "2015-03-11",
    "tipo" : "presencial",
    "contato_responsavel" : "11111111111",
    "nome_responsavel" : "respapi",
    "sobrenome_responsavel" : "sobreapi",
    "sexo_responsavel" : "M",
    "cpf_responsavel" : "111.111.111-11",
    "rg_responsavel" : "111.111.111-11",
    "email_responsavel" : "respapi@gmail.com",
    "nascimento_responsavel" : "1990-03-25",
    "cep_responsavel" : "69099-380",
    "cidade_responsavel" : "Manaus",
    "endereco_responsavel" : "Rua sobe e desce",
    "estado_responsavel" : "AM", 
    "pais_responsavel" : "Brasil"
}'

Respostas

🟢201Criado
application/json
Body

Exemplo
{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "nome": "string",
        "sobrenome": "string",
        "tipo": "string",
        "nascimento": "string",
        "anotacao": null,
        "usuario": "string",
        "email": "string",
        "cpf": "string",
        "telefone": "string",
        "endereco": "string",
        "cidade": "string",
        "estado": "string",
        "pais": "string",
        "dataCriado": "string",
        "cep": "string",
        "sexo": "string",
        "rg": "string",
        "nome_responsavel": "string",
        "sobrenome_responsavel": "string",
        "rg_responsavel": "string",
        "grupo": null,
        "cpf_responsavel": "string",
        "sexo_responsavel": "string",
        "nascimento_responsavel": "string",
        "endereco_responsavel": "string",
        "cidade_responsavel": "string",
        "estado_responsavel": "string",
        "pais_responsavel": "string",
        "cep_responsavel": "string",
        "contato_responsavel": "string",
        "email_responsavel": "string"
    },
    "timestamp": "string",
    "status_code": 0
}
Página anterior
Listar aluno pelo ID
Próxima página
Atualizar aluno
Built with