Fábrica de Software TOTVS BH

Atalhos

Páginas filhas
  • Documentação API - Loja Click - Moodle

Este documento tem por objetivo a documentar a 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


POST
/api/cst/v1/intmoodle/aluno/exportarMatricAluno

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 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.

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

Authorization - Basic Auth

Username <username>

Password <password>


Raw
{
    "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

Console
{
    "Status": "Sucesso",
    "Mensagem": "Usuário do aluno Exportado com Sucesso! Matrícula do Aluno Exportada com Sucesso! Grupo Turma Exportado com Sucesso! Plano de Ensino Exportado para o Moodle com Sucesso!",
    "DadosCriados": {
        "CodColigada": 3,
        "Ra": "00878180",
		"IdPerlet": 3800,
		"IdHabilitacaoFilial": 71177,
		"IdSalaMoodle":[
			24054,
			23537,
			23538,
			23539,
			23540,
			23541,
			23542
		],
        "IdUsuarioMoodle": 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: Código da Coligada utilizado no registro
    • Ra: Ra criado ou atualizado para o aluno enviado.
    • IdPerlet: 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 Moodle.
  • 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.