Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Loja Click SESI - SENAI - FIEPa API chamada “Moodle - Exportação de Matrículas de Alunos da Loja” que irá disparar automaticamente o processo do Moodle de Exportação de Matrículas e Docentes/Professores para o aluno que teve a matrícula e contrato efetivados com sucesso.
Orientações gerais, autenticação e exemplos de consumo das API's.
| Expandir |
|---|
| title | Exportar para Moodle Matrículas de Alunos da Loja Click |
|---|
|
| HTML |
|---|
<div class="post">POST</div>
<div class="endereco">/api/cst/v1/intmoodle/aluno/exportarMatricAluno</div> |
Ao executar a chamada da API, serão realizadas as seguintes operações: - Inserir usuários no Moodle, caso não exista;
- Inscrever usuário no Curso;
- Inserir Grupo do usuário (Turma e Matriz Curricular - SESI);
- Inserir Plano de Aprendizagem do Aluno;
- Devolve para Loja/Ace o status do processamento (Response).
| Informações |
|---|
| title | Informações Relevantes |
|---|
| - A nova API irá registrar os dados no mesmo Monitor de log de exportação do Moodle, da mesma forma como acontece com o processo original de exportação do Moodle.
- A API de importação de matrículas já existente foi atualizada para devolver um identificador único ao ACE, facilitando a chamada da nova API.
- Não será possível reenviar esse registro com erro através do Monitor de log, já que dessa forma a Loja não será avisada da integração com sucesso.
|
| Aviso |
|---|
Será responsabilidade do ACE acionar a nova API para disparar o processo de exportação do Moodle, que enviará os dados do aluno e da matrícula efetuada para o Moodle. |
Autenticação
| Card |
|---|
| Authorization - Basic AuthUsername <username> Password <password>
|
| Bloco de código |
|---|
| {
"codColigada": 3,
"idUnico": 1
} |
Content - codColigada: Código da Coligada no SGE (Campo Obrigatório);
- idUnico: Identificador da Matrícula realizada no SGE pela Loja Click;
Retorno| Bloco de código |
|---|
| {
"Status": "Sucesso",
"Mensagem": "Usuário do aluno Exportado com Sucesso! Matrícula do Aluno Criado/AtualizadoExportada com Sucesso! Grupo Turma Exportado com Sucesso! Plano de Ensino Exportado para o Moodle com Sucesso!",
"DadosCriados": {
"CodColigada": null3,
"Ra": "00878180",
"NomeIdPerlet": Rafael da Silva Sauro, 3800,
"CPFIdHabilitacaoFilial": 12313133171177,
"CodCFO": null "IdSalaMoodle":[
24054,
23537,
23538,
"CodFilial": 3015 23539,
"IdHabilitacaoFilial: 711123540,
"IdPerlet": 3800,
"CodTurma": "TEC-M-000152/2023" 23541,
23542
],
"IdPreContratoIdUsuarioMoodle": 266262,
"IdUnico": 10
110687
},
"DetalheErros": {
"IdErro": null,
"ExceptionType": null,
"InnerException": null
}
} |
Content - Status: Situação do processamento da requisição; Valores possíveis: "Sucesso" = Quando todas as etapas foram inseridas com sucesso; "Erro" = Quando ocorre um erro na integração com o SGE até a etapa de Criação de Matricula do Aluno; "Alerta" = Quando ocorre um erro na etapa de Efetivação do Contrato no ERP;
- Mensagem: Mensagem de retorno do consumo da requisição;
- Dados Criados:
- CodColigada: Codigo Código da Coligada utilizado no registro
- Ra: Ra criado ou atualizado para o aluno enviado.
- NomeIdPerlet: Nome do aluno enviado na API.
- CPF: Cpf do aluno enviado na API.
- CodCFO: Codigo do Cliente/Fornecedor para o responsável financeiro criado ou atualizado.
- IdPreContrato: Id interno no criado para o Pré Contrato CRM.
- Id do Período Letivo da matricula do aluno no SGE
- IdSalaMoodle: Lista das salas em que o aluno está matriculado no Moodle.
- IdUsuarioMoodle: Identificador do usuário do aluno no MoodleIdUnico: Numero único atribuído a efetivação da matricula com sucesso pela API. Somente é gerado em caso de efetivação do contrato com sucesso.
- DetalheErros:
- IdErro: Identificador da região da API que ocorreu o erro. Valores possíveis: 1 = Responsável Financeiro; 2 = Aluno; 3 = Matricula; 4 = Pré Contrato CRM; 5 = Efetivação Contrato ERP
- ExceptionType: Tipo da exceção lançada pela API.
- InnerException: Conteúdo extra da exceção lançada pela API.
|
...
