Olá, cliente JACAD, tudo bem? Este guia traz todas as instruções necessárias para a utilização de API Fluxo Completo de Matrícula de Aluno. Boa leitura!

ÍNDICE

• 1. INTRODUÇÃO
• 2. AUTENTICAÇÃO
• 3. CADASTRO DE PERFIL
  •  3.1. Endpoint
  • 3.2. Campo Obrigatórios
  • 3.3. Exemplo Prático
• 4. CADASTRO ALUNO
  • Figura 4
  • 4.2. Campo Obrigatórios
  • 4.3. Exemplo Prático
• 5. CADASTRO DE CURSO INGRESSO
  • 5.1. Endpoint
  • 5.2. Campo Obrigatórios
  • 5.3. Exemplo Prático
• 6. CADASTRO DE MATRICULA
  • 6.1. Endpoint
  • 6.2. Campo Obrigatórios
  • 6.3. Exemplo Prático
• 7. CONCLUSÃO

1. INTRODUÇÃO

A Interface de Programação de Aplicações (API) é uma ferramenta que permite a comunicação entre diferentes sistemas de forma estruturada e automatizada. No caso da API do JACAD, ela possibilita o envio e recebimento de dados entre o seu sistema e a nossa plataforma com segurança e eficiência.

Este documento descreve o Fluxo Completo de Matrícula de Aluno, contemplando todas as etapas necessárias:

• Criação do perfil do usuário;
• Cadastro do aluno vinculado ao perfil;
• Registro do curso ingresso com suas respectivas informações;
• Efetivação da matrícula do aluno no sistema acadêmico.

O objetivo é orientar de forma prática e clara como consumir os endpoints da API em cada fase, garantindo a correta integração com o JACAD.

2. AUTENTICAÇÃO

Antes de qualquer coisa, você precisa se autenticar na plataforma para usar a API. A autenticação é como uma Chave de entrada para garantir que apenas usuários autorizados consigam fazer alterações.

O JACAD utiliza Token na tela de Cadastro de Tokens de Acesso.

Vá no menu Integrações navegue até API de Integração e clique em Tokens de Acesso e com isso acessar a tela de Cadastro de Tokens de Acesso.

Figura 1

3. CADASTRO DE PERFIL

O primeiro passo é criar um Perfil para o aluno, utilizando o endpoint de cadastro de perfil disponibilizado pela API do JACAD. Esse perfil representa os dados pessoais básicos do usuário e é essencial para todas as etapas seguintes do fluxo de matrícula, pois o ID do perfil será utilizado como referência na criação do aluno.

 
3.1. Endpoint

Para cadastrar um perfil, utilize a seguinte URL:

POST {{baseUrl}}/api/v1/basicos/perfis

Figura 2

3.2. Campo Obrigatórios

Você deve preencher pelo menos os seguintes campos:

• dataNascimento

• email

• idCliente

• idOrg

• nome

• sexo

Esses dados são o mínimo necessário para criar um novo perfil.

3.3. Exemplo Prático

Figura 3

4. CADASTRO ALUNO

O segundo passo é criar um Cadastrar um Aluno, utilizando o endpoint de cadastro de aluno disponibilizado pela API do JACAD. Esse cadastro formaliza o vínculo entre o perfil previamente criado e a estrutura acadêmica da instituição, permitindo o prosseguimento para o ingresso em um curso e matrícula. 

4.1. Endpoint

Para cadastrar um aluno, utilize a seguinte URL:

POST {{baseUrl}}/api/v1/academico/alunos

Figura 4

4.2. Campo Obrigatórios

Você deve preencher pelo menos os seguintes campos:

• idPerfil

• idOrg

• ra

Esses dados são o mínimo necessário para criar um novo aluno.

4.3. Exemplo Prático

Figura 5

5. CADASTRO DE CURSO INGRESSO

O terceiro passo do fluxo é o Cadastro do curso ingresso, que representa o momento em que o aluno é oficialmente vinculado a um curso, período letivo e turma dentro da instituição. Esse passo é fundamental para estabelecer o vínculo acadêmico do aluno com a estrutura curricular.

Para dar continuidade e conseguir cadastrar um curso ingresso é preciso primeiro criar pelo jacad desktop Curso , Matriz Curricular, Período Letivo e Turma.

5.1. Endpoint

Para cadastrar um aluno, utilize a seguinte URL:

POST {{baseUrl}}/api/v1/academico/cursos-ingressos/

Figura 6

5.2. Campo Obrigatórios

Você deve preencher pelo menos os seguintes campos:

• alunoProcedenteEscolaPublica

• dataRegistro

• idAluno

• idCurso

• idTipoProcessoSeletivo

• status

• turma

Esses dados são o mínimo necessário para cadastrar um curso ingresso.

5.3. Exemplo Prático

Figura 7

6. CADASTRO DE MATRICULA

O quarto e último passo do fluxo é o Cadastro da matrícula do aluno, que oficializa a participação do estudante em disciplinas específicas dentro de uma turma e período letivo. Essa ação consolida todo o processo anterior e permite que o aluno passe a fazer parte ativa do ciclo acadêmico.

6.1. Endpoint

Para cadastrar um aluno, utilize a seguinte URL:

POST {{baseUrl}}/api/v1/academico/matriculas/

Figura 8 

6.2. Campo Obrigatórios

Você deve preencher pelo menos os seguintes campos:

• dataMatricula

• dataPrimeiraParcela

• idAlunoCursoIngresso

• idPeriodoLetivo

• idTurma

• idsDisciplinasProfessor
 

Esses dados são o mínimo necessário para cadastrar um curso ingresso.

6.3. Exemplo Prático

Figura 9

Apresentando nas Figura 10 e 11 o resultado na criação do aluno, inserindo o curso ingresso no aluno e cadastrando uma matricula para o aluno.

Figura 10

Figura 11

7. CONCLUSÃO

Chegamos ao final deste guia sobre a Api Fluxo Completo de Matrícula de Aluno no sistema JACAD! Esperamos que este material tenha sido útil para auxiliá-lo na configuração dessa funcionalidade. Em caso de dúvidas ou necessidade de suporte, fique à vontade para consultar nossa base de conhecimento ou entrar em contato com nossa equipe de suporte técnico.

 Agradecemos por confiar no JACAD e desejamos muito sucesso na gestão da sua instituição.

Até breve!