Olá, cliente JACAD, tudo bem? Este guia traz todas as instruções necessárias para o uso do recurso de atividades de extensão. Boa leitura!

ÍNDICE

• 1. INTRODUÇÃO
• 2. PERMISSÃO
• 3. AUTENTICAÇÃO
• 4. API ATIVIDADES DE EXTENSÃO 
  • 4.1. GET - Lista de Atividades de Extensão de Unidades Curriculares
  • 4.2. POST – Cadastrar Atividade de Extensão de Unidade Curricular
  • 4.3. POST - Atividade de Extensão de Unidade Curricular - Enviar Arquivo do Aluno
  • 4.4. POST - Atividade de Extensão de Unidade Curricular - Anexar arquivo da Atividade do Professor
  • 4.5. GET - Lista de Atividades de Extensão de Disciplinas
  • 4.6. POST – Cadastrar Atividade de Extensão de Disciplinas
  • 4.7. POST – Atividade de Extensão de Disciplinas - Enviar Arquivo do Aluno
  • 4.8. POST – Atividade de Extensão de Disciplinas - Anexar arquivo da Atividade do Professor
• 5. CONCLUSÃO

1. INTRODUÇÃO

Este guia tem como objetivo apresentar, de forma clara e prática, as funcionalidades da API de Atividades de Extensão do sistema JACAD. Desenvolvido para atender às demandas de instituições de ensino que desejam integrar e automatizar processos relacionados às atividades de extensão, o documento fornece orientações completas sobre permissões necessárias, autenticação e os principais endpoints disponíveis para consulta, cadastro e gerenciamento dessas atividades, tanto por unidade curricular quanto por disciplina. Ao seguir este material, os usuários estarão aptos a realizar integrações eficientes com a plataforma, garantindo maior agilidade e organização no acompanhamento das atividades acadêmicas.

2. PERMISSÃO

Para habilitar o acesso ao recurso de atividade de extensão aos usuários do sistema SWA.JACAD, é necessário liberar a permissão de acesso.

Dessa forma, siga o passo a passo abaixo para mais informações sobre como realizar esse processo.

PASSO 1: Acesse o Menu 'Preferências', navegue até 'Usuários e Permissões' e clique no submenu 'Permissões'.

Figura 1

PASSO 2: Na tela 'Controle de Permissões de Acesso', selecione um grupo de usuário.

Figura 2

PASSO 3: Navegue até a tabela 'Grupo de permissões' e selecione o grupo de permissões clicando em 'API de Integração'.

Figura 3

PASSO 4: Em Filtrar escreva 'Extensão' e marque os dois itens de permissão.

Figura 4

OBSERVAÇÃO: O procedimento de liberação deve ser realizado para todos os grupos de usuários que deverão ter o acesso ao recurso de atividade de extensão.

3. 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á ao 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 5

4. API ATIVIDADES DE EXTENSÃO 

Acesse o painel das documentações da api e acesse o acadêmico.

Figura 6

Acessando o painel acadêmico vá até a opção 'Atividades de Extensão'. Nela estão todas as APIs relacionado a atividades de extensão.

Figura 7

Figura 8

4.1. GET - Lista de Atividades de Extensão de Unidades Curriculares

Ao acessar o método GET 'Lista de Atividades de Extensão de Unidades Curriculares', ao informar apenas os parâmetros obrigatórios (ou aplicando quaisquer filtros).

Figura 9

O resultado da consulta lista as atividades conforme o tamanho do 'pageSize' configurado, onde é apresentada todas as informações contidas nas atividades cadastradas como unidade curricular para aquele curso ingresso.

Figura 10

4.2. POST – Cadastrar Atividade de Extensão de Unidade Curricular

No Postman, aplicando como body os parâmetros de criação da atividade por Unidade Curricular.

Figura 11

Após o sucesso do envio, é exibido todos os elementos da atividade recém criada

Figura 12

OBSERVAÇÃO: Ao cadastrar por API a atividade do tipo Unidade Curricular, ela será vinculada a todos os alunos matriculados na matriz origem do idUnidadeCurricular, por isso, é apresentada outra aluna na resposta, pois ela faz parte da mesma matriz. 

4.3. POST - Atividade de Extensão de Unidade Curricular - Enviar Arquivo do Aluno

Figura 13

A fim de cadastrar o arquivo do aluno em uma atividade já criada, a API necessita de dois parâmetros para identificar a atividade que receberá o arquivo.

Figura 14 

E no body, o parâmetro 'file' para informar o arquivo

Figura 15

4.4. POST - Atividade de Extensão de Unidade Curricular - Anexar arquivo da Atividade do Professor

Figura 16

Para anexar o arquivo da atividade do professor, é necessário informar apenas o 'idAtividade' e o arquivo 'file' no body na requisição que a execução é criada com sucesso.

Figura 17

4.5. GET - Lista de Atividades de Extensão de Disciplinas

Figura 18

A listagem das atividades por tipo Disciplina segue o mesmo fluxo do tipo Unidade Curricular, modificando apenas o filtro opcional idUnidadeCurricular por 'idDisciplina'.

Figura 19

Retornando corretamente as atividades cadastradas para aquele aluno curso ingresso.

Figura 20

4.6. POST – Cadastrar Atividade de Extensão de Disciplinas

Figura 21

Utilizando o 'idDisciplinaProfessor' para selecionar a disciplina destino da atividade, o request também é feito através do body.

Figura 22

E é retornado todos os elementos que compõe tal atividade.

Figura 23

OBSERVAÇÃO: As atividades de extensão do tipo Disciplina quando cadastradas através da API, tem como comportamento serem vinculadas a todos os alunos que fazem parte da disciplina informada pelo 'idDisciplinaProfessor', por isso da resposta apresentar um aluno diferente do informado pelo 'idAlunoCursoIngresso'.

4.7. POST – Atividade de Extensão de Disciplinas - Enviar Arquivo do Aluno

Figura 24

Da mesma forma, ao informar o 'idAtividade', o 'idAlunoCursoIngresso' e o 'file', ao executar a requisição o arquivo é cadastrado.

Figura 25

4.8. POST – Atividade de Extensão de Disciplinas - Anexar arquivo da Atividade do Professor

Figura 26

Ao informar o 'idAtividade' e o arquivo no body à 'file', o arquivo da atividade é cadastrado corretamente.

Figura 27

5. CONCLUSÃO

Chegamos ao final deste guia sobre a Api de atividades de extensão 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!