Funcao da API

Cadastro base de alunos

Esta API permite que um sistema externo envie os dados principais do aluno para o EasyDiplomas. Ela nao emite certificado, nao gera XML e nao preenche dados de SISTEC.

Autenticacao

Token Bearer gerado no painel administrativo.

Acesse Configuracoes > API, gere o token e envie-o no cabecalho de todas as requisicoes. Ao regenerar o token, o token anterior deixa de funcionar.

Authorization: Bearer SEU_TOKEN

POST

/api/alunos

Cria somente o cadastro base do aluno. Se o rewrite do servidor nao estiver ativo, use a chamada alternativa: index.php?controller=ApiController&action=createStudent.

POST https://seu-dominio.com/api/alunos
Authorization: Bearer SEU_TOKEN
Content-Type: application/json

{
  "student": {
    "name": "Joao Carlos da Silva",
    "cpf": "01111111111",
    "rg": "11111111",
    "birth_date": "1997-12-02",
    "birthplace": "Florianopolis - SC",
    "nationality": "Brasileira",
    "father_name": "Carlos da Silva",
    "mother_name": "Maria da Silva",
    "course_id": 1,
    "start_date": "2024-02-01",
    "completion_date": null
  }
}

Campos aceitos

Campo	Obrigatorio	Descricao
name	Sim	Nome completo do aluno.
cpf	Sim	CPF com 11 digitos. Pode vir com ou sem pontuacao.
rg	Sim	RG com 5 a 14 caracteres.
birth_date	Nao	Data de nascimento no formato YYYY-MM-DD.
birthplace	Nao	Naturalidade/cidade de nascimento.
nationality	Nao	Nacionalidade.
father_name	Nao	Nome do pai.
mother_name	Nao	Nome da mae.
course_id	Nao	ID de um curso ja cadastrado no sistema.
start_date	Nao	Data de inicio no formato YYYY-MM-DD.
completion_date	Nao	Data de conclusao no formato YYYY-MM-DD.

Sucesso

{
  "success": true,
  "message": "Aluno base cadastrado com sucesso.",
  "student_id": 123
}

Erros

400 JSON invalido.

401 Token ausente ou invalido.

405 Metodo diferente de POST.

422 Falha de validacao, CPF/RG duplicado ou curso inexistente.

Importante

Mesmo que o curso seja tecnico, os dados de SISTEC nao sao preenchidos por esta API. A equipe deve complementar essas informacoes posteriormente no painel do EasyDiplomas.