Olá, cliente JACAD, tudo bem? Este guia traz todas as instruções necessárias para a utilização de api cadastro de aluno. Boa leitura!

ÍNDICE 

• 1. INTRODUÇÃO
• 2. AUTENTICAÇÃO
• 3. CADASTRO DE ALUNO
  • 3.1. Endpoint
  • 3.2. Campo Obrigatórios
• 4. CONFIGURAÇÕES DO CADASTRO DE ALUNO
  • 4.1. Entendendo o formato do RA
  • 4.2. Como personalizar o RA via API
  • 4.3. Exemplo prático
• 5. CONCLUSÃO

1. INTRODUÇÃO

API (Interface de Programação de Aplicações) é uma ferramenta que permite que diferentes sistemas "conversem" entre si. No nosso caso, a API da JACAD permite que você envie e receba dados entre seu sistema e a nossa plataforma, de forma segura e automatizada.

Por exemplo: você pode cadastrar perfis de usuários no seu sistema e esses dados serão automaticamente registrados também na 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'.

Acesse o Menu 'Integrações' navegue até 'API de Integração' e clique em 'Tokens de Acesso' e com isso acesse a tela de 'Cadastro de Tokens de Acesso'.

Figura 1

3. CADASTRO DE ALUNO

3.1. Endpoint

Para cadastrar um perfil, utilize a seguinte URL:

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

Figura 2

3.2. Campo Obrigatórios

Você deve preencher pelo menos os seguintes campos:

• idOrg

• idPerfil

• ra

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

4. CONFIGURAÇÕES DO CADASTRO DE ALUNO

Ao realizar o cadastro do aluno, no momento de inserir as informações para o 'RA' deve verificar a tela 'Configurações de Aluno'. Para ver a estrutura de como deve ser formado o 'RA'.

PASSO 1:Acesse o Menu 'Preferências', navegue até 'Configurações', clique em 'Acadêmicas' e clique em 'Aluno'.

Figura 3

Na tela 'Configurações do Aluno' será a estrutura de como irá ficar o RA.

Figura 4

4.1. Entendendo o formato do RA

Se no sistema estiver configurado como '<CODIGO>-<ANO>', o RA será automaticamente formatado dessa forma, mesmo que você envie outro valor pela API. O sistema vai ignorar o valor e montar o RA com base no código do aluno e o ano. Como apresentado nas Figuras 5 e Figura 6.

Figura 5

Figura 6

4.2. Como personalizar o RA via API

Se você quiser que o valor enviado na API apareça no RA, precisa ajustar a tela de 'Configurações do Aluno'. No campo 'Formato RA' a TAG '<CODIGO_INFORMADO>'.

Observações: Para definir o formato do RA deve constar a TAG '<CODIGO>' ou '<SEQUENCIAL>'.

Figura 7

4.3. Exemplo prático

Se você configurar o RA como, '<SEQUENCIAL>-<CODIGO_INFORMADO>'.

E mandar pela API um código como "C123", o sistema pode gerar um RA como 'C123-001', 'C123-002', e assim por diante, criando uma sequência automática. Representação visual nas Figuras 8 e 9.

Figura 8

Figura 9

5. CONCLUSÃO

Chegamos ao final deste guia sobre a Api de Cadastro 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!