Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Loja Click SESI - SENAI - FIEP.


Orientações gerais, autenticação e exemplos de consumo das API's.


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


{
    "codColigada": 3,
    "idUnico": 1
}


Content

  • codColigada: Código da Coligada no SGE (Campo Obrigatório);

Retorno

{
    "Status": "Sucesso",
    "Mensagem": "Aluno Criado/Atualizado com Sucesso !",
    "DadosCriados": {
        "CodColigada": null,
        "Ra": "00878180",
  		"Nome": Rafael da Silva Sauro,   
		"CPF": 123131331,
        "CodCFO": null,
		"CodFilial": 3015,
		"IdHabilitacaoFilial: 7111,
		"IdPerlet": 3800,
		"CodTurma": "TEC-M-000152/2023",
        "IdPreContrato": 266262,
		"IdUnico": 10
    },
    "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 da Coligada utilizado no registro
    • Ra: Ra criado ou atualizado para o aluno enviado.
    • Nome: 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.
    • IdUnico: 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.


<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 30px;
	    font-size: 20px;
	    padding: 5px;
	}
	.expand-control-text {
    	vertical-align: top;
	    font-weight: bold;
		color: #242424;
	}
	.post {
    	background-color: #378000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.get {
    	background-color: #004fd6;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.put {
    	background-color: #ffa200;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.delete {
    	background-color: #cf0000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.endereco{
		display: inline-block;
		padding: 5px;
		font-weight: bold;
	}
</style>
<!-- 
EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
<div class="post">POST</div>
<div class="get">GET</div>
<div class="put">PUT</div>
<div class="delete">DELETE</div>

O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
-->