{"id":12660,"date":"2024-05-09T10:50:27","date_gmt":"2024-05-09T13:50:27","guid":{"rendered":"https:\/\/unimestre.com\/basedeconhecimento\/?p=12660"},"modified":"2024-05-09T10:53:36","modified_gmt":"2024-05-09T13:53:36","slug":"estuda-integracao-de-sistema-de-terceiros-com-estudamais","status":"publish","type":"post","link":"https:\/\/unimestresuperior.com\/basedeconhecimento\/estuda-integracao-de-sistema-de-terceiros-com-estudamais\/","title":{"rendered":"Estuda+ – Integra\u00e7\u00e3o de sistema de terceiros com estudamais"},"content":{"rendered":"

Integra\u00e7\u00e3o de sistema de terceiros com estudamais<\/h1>\n

Este artigo tem como objetivo demonstrar como outros sistemas podem se integrar com o Estudamais. O processo de integra\u00e7\u00e3o entre esses dois sistemas segue os modelos de requisi\u00e7\u00e3o e resposta descritos abaixo.<\/p>\n

A integra\u00e7\u00e3o opera da seguinte maneira: sempre que o LMS enviar uma requisi\u00e7\u00e3o para o sistema de terceiros, ele incluir\u00e1 um par\u00e2metro na URL chamado API, que indica o tipo de a\u00e7\u00e3o ou pergunta que est\u00e1 sendo feita para o sistema de terceiros. Portanto, \u00e9 crucial ter o modelo de resposta implementado previamente.<\/p>\n

O sistema de terceiro n\u00e3o precisa alimentar a estrutura do LMS. A pr\u00f3pria aplica\u00e7\u00e3o vai entrar em contato com o sistema de terceiro e buscar as informa\u00e7\u00f5es.<\/p>\n

Abaixo \u00e9 poss\u00edvel ver as principais chaves para integrar a pessoa, curso, turma, matr\u00edcula e realizar o login no LMS.<\/p>\n\n\n\n\n\n\n\n\n\n\n
Chave<\/th>\nObrigat\u00f3rio<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
ApiUnimMoodleCursos<\/td>\nSim<\/td>\nA\u00e7\u00e3o respons\u00e1vel por recuperar a lista de cursos que devem ser integrados. Evite trazer listas enormes de registros. Utilize alguma l\u00f3gica de per\u00edodo.<\/td>\n<\/tr>\n
lms.ApiPessoa<\/td>\nSim<\/td>\nA\u00e7\u00e3o respons\u00e1vel por recuperar as informa\u00e7\u00f5es da pessoa no cadatro do terceiro. \u00c9 essa a\u00e7\u00e3o que tr\u00e1s a pessoa para dentro do LMS ou vincula a pessoa ao curso EAD como professor, coordenador ou tutor.<\/td>\n<\/tr>\n
ApiUnimMoodleCursosMatriculas<\/td>\nSim<\/td>\nA\u00e7\u00e3o respons\u00e1vel por recuperar todas as matriculas de uma pessoa. Nela tamb\u00e9m \u00e9 poss\u00edvel visualizar informa\u00e7\u00f5es importantes do curso e da turma. \u00c9 nesse momento que a turma \u00e9 criada no LMS e a pessoa \u00e9 matriculada.<\/td>\n<\/tr>\n
lms.ApiMatricula<\/td>\nSim<\/td>\nA\u00e7\u00e3o respons\u00e1vel por recuperar a quantidade de matr\u00edculas do aluno<\/td>\n<\/tr>\n
lms.ApiFichaIndividual<\/td>\nSim<\/td>\nA\u00e7\u00e3o respons\u00e1vel por atualizar a situa\u00e7\u00e3o da matr\u00edcula no LMS. O LMS executa essa chamada para o sistema de terceiro a cada 15min.<\/td>\n<\/tr>\n
ApiLiberacaoCursoLms<\/td>\nSim<\/td>\nA\u00e7\u00e3o respons\u00e1vel por consultar se a pessoa tem alguma libera\u00e7\u00e3o financeira em alguma disciplina especifica.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Importante<\/strong>: Mesmo que a chave n\u00e3o seja utilizada para os fins mencionados acima, \u00e9 necess\u00e1rio implement\u00e1-la. No caso de n\u00e3o ser utilizada, \u00e9 importante implementar um retorno vazio.<\/p>\n

Requisitos<\/h2>\n

A partir de agora, vamos usar como exemplo a URL\u00a0http:\/\/sistema.terceiro.com.br<\/a>\u00a0como sendo a URL de integra\u00e7\u00e3o. Antes de iniciar, \u00e9 importante ter a integra\u00e7\u00e3o do lado do LMS configurada pela equipe de servi\u00e7os. \u00c9 por esse passo que eles v\u00e3o pegar a URL de exemplo e cadastrar para que o LMS saiba por onde ele deve se comunicar.<\/p>\n

Integra\u00e7\u00e3o do curso<\/h2>\n

A integra\u00e7\u00e3o de cursos sempre vai esperar como resposta um array de objetos no formato JSON. Cada registro \u00e9 um curso diferente. Essa integra\u00e7\u00e3o acontece sempre automaticamente pelo agendamento que acontece a cada 15m ou mais.<\/p>\n

[GET]<\/strong>\u00a0http:\/\/sistema.terceiro.com.br\/exemplo.php?api=ApiUnimMoodleCursos<\/a><\/p>\n

Exemplo de como a resposta DEVE ser<\/h3>\n
[\r\n  {\r\n    \"cd_moodle_curso\": \"2\",\r\n    \"ds_descricao\": \"CURSO TESTE INTEGRA\u00c7\u00c3O - 07\/05\/2024\",\r\n    \"ds_sigla\": \"CTI\",\r\n    \"dt_revisao\": \"2024-05-06 17:50:59\",\r\n    \"sn_separar_turma\": \"1\",\r\n    \"sn_curso_modelo\": null,\r\n    \"cd_curso_modelo\": null,\r\n    \"nr_grau\": \"1\",\r\n    \"nr_serie\": \"1\",\r\n    \"ds_grau\": \"ENSFUND\",\r\n    \"ds_hash_md5\": \"79cdb28f5c1f94045e0b8403450ea53d\",\r\n    \"ds_metodo_importacao\": \"parcial\",\r\n    \"cd_avaliacao_tipo\": \"1\",\r\n    \"cd_coordenador\": \"248827\",\r\n    \"cd_tutor\": \"510287\"\r\n  },\r\n  {\r\n    \"... pr\u00f3ximo curso\"\r\n  }\r\n]\r\n<\/code><\/pre>\n
Campos<\/h3>\n
Abaixo segue a descri\u00e7\u00e3o dos campos mais relevantes.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
cd_moodle_curso<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo \u00fanico para o curso<\/td>\n<\/tr>\n
ds_descricao<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nNome do curso<\/td>\n<\/tr>\n
sn_separar_turma<\/td>\nsmallint<\/td>\nSim<\/td>\n1<\/td>\nDefine como as turmas v\u00e3o ser organizadas dentro do curso. 1 = Todas as turmas do curso v\u00e3o para uma \u00fanica turma do LMS chamada turma geral. 2 = Organizar os alunos cada um em sua respectiva turma de acordo com a matr\u00edcula dele. 3 = Organizar os alunos em turmas mensais. Ser\u00e3o criadas turmas de Janeiro a Dezembro e os alunos ser\u00e3o organizados de acordo com o m\u00eas da matr\u00edcula.<\/td>\n<\/tr>\n
ds_hash_md5<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nChave respons\u00e1vel por definir a integridade do curso. Para informar ele, voc\u00ea deve gerar um hash que comp\u00f5e os campos\u00a0cd_moodle_curso<\/code>,\u00a0ds_descricao<\/code>,ds_sigla<\/code>,ds_metodo_importacao<\/code>,cd_avaliacao_tipo<\/code>,sn_separar_turma<\/code>\u00a0e\u00a0grau<\/code>.<\/td>\n<\/tr>\n
nr_grau<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nDefine o grau do curso, ver a tabela de refer\u00eancia abaixo.<\/td>\n<\/tr>\n
ds_metodo_importacao<\/td>\nstring<\/td>\nSim<\/td>\nparcial<\/td>\nDefine como as notas ser\u00e3o devolvidas para o sistema de terceiro.\u00a0parcial<\/code>\u00a0= Cada atividade avaliativa ser\u00e1 enviada individualmente.\u00a0media<\/code>\u00a0= Somente a m\u00e9dia ser\u00e1 integrada.\u00a0nao_importar<\/code>\u00a0= N\u00e3o integra nenhuma atividade.<\/td>\n<\/tr>\n
cd_avaliacao_tipo<\/td>\nsmallint<\/td>\nSim<\/td>\n1<\/td>\nDefine um c\u00f3digo especifico para o tipo de avalia\u00e7\u00e3o que deve ser retornado para o sistema de terceiro.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Tabela de refer\u00eancia para os graus do curso<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
C\u00f3digo<\/th>\nGrau<\/th>\nChave<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nEduca\u00e7\u00e3o Infantil<\/td>\nEI<\/td>\n<\/tr>\n
2<\/td>\n1\u00ba ano (Ensino Fundamental I)<\/td>\nEF1<\/td>\n<\/tr>\n
3<\/td>\n2\u00ba ano (Ensino Fundamental I)<\/td>\nEF2<\/td>\n<\/tr>\n
4<\/td>\n3\u00ba ano (Ensino Fundamental I)<\/td>\nEF3<\/td>\n<\/tr>\n
5<\/td>\n4\u00ba ano (Ensino Fundamental I)<\/td>\nEF4<\/td>\n<\/tr>\n
6<\/td>\n5\u00ba ano (Ensino Fundamental I)<\/td>\nEF5<\/td>\n<\/tr>\n
7<\/td>\n6\u00ba ano (Ensino Fundamental II)<\/td>\nEF6<\/td>\n<\/tr>\n
8<\/td>\n7\u00ba ano (Ensino Fundamental II)<\/td>\nEF7<\/td>\n<\/tr>\n
9<\/td>\n8\u00ba ano (Ensino Fundamental II)<\/td>\nEF8<\/td>\n<\/tr>\n
10<\/td>\n9\u00ba ano (Ensino Fundamental II)<\/td>\nEF9<\/td>\n<\/tr>\n
11<\/td>\n1\u00aa s\u00e9rie do Ensino M\u00e9dio<\/td>\nEM1<\/td>\n<\/tr>\n
12<\/td>\n2\u00aa s\u00e9rie do Ensino M\u00e9dio<\/td>\nEM2<\/td>\n<\/tr>\n
13<\/td>\n3\u00aa s\u00e9rie do Ensino M\u00e9dio<\/td>\nEM3<\/td>\n<\/tr>\n
14<\/td>\n4\u00ba ano Ensino M\u00e9dio<\/td>\nEM4<\/td>\n<\/tr>\n
16<\/td>\nCursos Livres<\/td>\nCL<\/td>\n<\/tr>\n
18<\/td>\nOlimp\u00edada+<\/td>\nOLI<\/td>\n<\/tr>\n
19<\/td>\nGradua\u00e7\u00e3o<\/td>\nG<\/td>\n<\/tr>\n
20<\/td>\nP\u00f3s Gradua\u00e7\u00e3o<\/td>\nPG<\/td>\n<\/tr>\n
21<\/td>\nMestrado<\/td>\nM<\/td>\n<\/tr>\n
22<\/td>\nDoutorado<\/td>\nD<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Integra\u00e7\u00e3o da pessoa<\/h2>\n
Essa api \u00e9 respons\u00e1vel por perguntar ao sistema de terceiro se a pessoa que est\u00e1 sendo requisitada existe. Se existir, faz a integra\u00e7\u00e3o dela para o LMS.<\/p>\n
A integra\u00e7\u00e3o de pessoa \u00e9 feito exclusivamente sob demanda no momento do login de cada usu\u00e1rio.<\/p>\n
[GET]<\/strong>\u00a0http:\/\/sistema.terceiro.com.br\/exemplo.php?api=lms.ApiPessoa&ds_login=320854&ds_senha=a9e697258f8471f2032f193786a12f30<\/a><\/p>\n
Par\u00e2metros<\/h3>\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
ds_login<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nUsu\u00e1rio \u00fanico<\/td>\n<\/tr>\n
ds_senha<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nSenha do usu\u00e1rio em formato texto ou hash encriptada<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Exemplo de como a resposta DEVE ser<\/h3>\n
{\r\n  \"success\": true,\r\n  \"message\": \"\",\r\n  \"result\": {\r\n    \"cd_pessoa\": \"248827\",\r\n    \"nm_pessoa\": \"ULISSES TESTE\",\r\n    \"ds_cpf\": \"03455537440\",\r\n    \"ds_sexo\": \"M\",\r\n    \"cd_estado_civil\": \"5\",\r\n    \"dt_nascimento\": \"1981-02-28 00:00:00\",\r\n    \"ds_login\": \"ulisses\",\r\n    \"cd_pais\": 1,\r\n    \"nm_pai\": \"Luiz Teste\",\r\n    \"nm_mae\": \"Miriam Teste\",\r\n    \"ds_identidade\": \"12340000\",\r\n    \"ds_identidade_orgao_exp\": \"SESP\",\r\n    \"dt_identidade_expedicao\": \"2003-01-08 00:00:00\",\r\n    \"ds_cep\": \"88318200\",\r\n    \"ds_estado\": \"SC\",\r\n    \"ds_pais\": \"Brasil\",\r\n    \"cd_estado\": \"42\",\r\n    \"ds_cidade\": \"Blumenau\",\r\n    \"ds_bairro\": \"BRILHANTE I\",\r\n    \"ds_logradouro\": \"RUA MOIS\u00c9S GAMBA\",\r\n    \"ds_logradouro_nro\": \"134\",\r\n    \"ds_complemento\": \"\",\r\n    \"ds_senha\": \"3343197f6927b267bd765361341e9cb3\",\r\n    \"ds_pais_nascimento\": \"BRASIL\",\r\n    \"cd_pais_nascimento\": \"10\",\r\n    \"ds_estado_nascimento\": \"SC\",\r\n    \"cd_estado_nascimento\": \"42\",\r\n    \"ds_cidade_nascimento\": \"Brusque\",\r\n    \"cd_pessoa_antigo\": null,\r\n    \"arrContatos\": [\r\n      {\r\n        \"cd_pessoa\": \"248827\",\r\n        \"ds_contato\": \"47999249293\",\r\n        \"ds_tipo_original\": \"Telefone Celular\"\r\n      },\r\n      {\r\n        \"cd_pessoa\": \"248827\",\r\n        \"ds_contato\": \"ulisses@amaiseducacao.com.br\",\r\n        \"ds_tipo_original\": \"E-mail\"\r\n      },\r\n      {\r\n        \"cd_pessoa\": \"248827\",\r\n        \"ds_contato\": \"47 11111-6666\",\r\n        \"ds_tipo_original\": \"Telefone Comercial\"\r\n      }\r\n    ],\r\n    \"arrGrupos\": [\r\n      {\r\n        \"cd_grupo\": \"2\",\r\n        \"ds_nome_grupo\": \"Estudantes\",\r\n        \"ds_papel\": \"ALUNO\",\r\n        \"cd_coligada\": \"1\",\r\n        \"nm_coligada\": \"Escola Teste - Unidade CENTRO\"\r\n      },\r\n      {\r\n        \"cd_grupo\": \"3\",\r\n        \"ds_nome_grupo\": \"Professores\",\r\n        \"ds_papel\": \"PROFESSOR\",\r\n        \"cd_coligada\": \"1\",\r\n        \"nm_coligada\": \"Escola Teste - Unidade CENTRO\"\r\n      },\r\n      {\r\n        \"cd_grupo\": \"4\",\r\n        \"ds_nome_grupo\": \"Coordena\u00e7\u00e3o\",\r\n        \"ds_papel\": \"COORDENADOR\",\r\n        \"cd_coligada\": \"1\",\r\n        \"nm_coligada\": \"Escola Teste - Unidade CENTRO\"\r\n      }\r\n    ]\r\n  }\r\n}\r\n<\/code><\/pre>\n
Campos<\/h3>\n
Abaixo segue a descri\u00e7\u00e3o dos campos mais relevantes.<\/p>\n\n\n\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
cd_pessoa<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo \u00fanico da pessoa<\/td>\n<\/tr>\n
ds_sexo<\/td>\nchar<\/td>\nN\u00e3o<\/td>\nM<\/td>\nF = Feminino e M = Masculino.<\/td>\n<\/tr>\n
cd_estado_civil<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nValores de refer\u1ebdncia em\u00a0estado civil da pessoa<\/a><\/td>\n<\/tr>\n
arrContatos.ds_tipo_original<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nValores de refer\u1ebdncia em\u00a0tipos de contatos da pessoa<\/a><\/td>\n<\/tr>\n
arrGrupos.ds_papel<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nValores de refer\u1ebdncia em\u00a0tipos de contatos da pessoa<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Tabela de refer\u00eancia para os\u00a0grupos dos usu\u00e1rios<\/span><\/h3>\n
Na lista de grupos da pessoa, o campo\u00a0ds_papel<\/code>\u00a0pode ser preenchido com os valores da coluna\u00a0Papel<\/code>\u00a0abaixo.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Papel<\/th>\nPerfil do LMS<\/th>\n<\/tr>\n<\/thead>\n
ALUNO<\/td>\nESTUDANTES<\/td>\n<\/tr>\n
ADMIN<\/td>\nADMINISTRADOR<\/td>\n<\/tr>\n
PROFESSOR<\/td>\nPROFESSORES<\/td>\n<\/tr>\n
COORDENADOR<\/td>\nCOORDENACAO<\/td>\n<\/tr>\n
ADMINISTRADOR<\/td>\nADMINISTRADOR<\/td>\n<\/tr>\n
TUTOR<\/td>\nTUTOR<\/td>\n<\/tr>\n
TUTORIA<\/td>\nTUTOR<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Tabela de refer\u00eancia para o\u00a0estado civil da pessoa<\/span><\/h3>\n
Na api de pessoa, o campo\u00a0cd_estado_civil<\/code>\u00a0pode ser preenchido com os valores da coluna\u00a0C\u00f3digo<\/code>\u00a0abaixo.<\/p>\n\n\n\n\n\n\n\n\n\n\n
C\u00f3digo<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nSolteiro(a)<\/td>\n<\/tr>\n
2<\/td>\nUni\u00e3o civil est\u00e1vel<\/td>\n<\/tr>\n
3<\/td>\nCasado(a)<\/td>\n<\/tr>\n
4<\/td>\nSeparado(a) Judicialmente<\/td>\n<\/tr>\n
5<\/td>\nDivorciado(a)<\/td>\n<\/tr>\n
6<\/td>\nVi\u00favo(a)<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Tabela de refer\u00eancia para os\u00a0tipos de contatos da pessoa<\/span><\/h3>\n
Na api de pessoa, o campo\u00a0ds_tipo_original<\/code>\u00a0pode ser preenchido com os valores da coluna\u00a0C\u00f3digo<\/code>\u00a0abaixo.<\/p>\n\n\n\n\n\n\n\n\n\n
C\u00f3digo<\/th>\nChave<\/th>\n<\/tr>\n<\/thead>\n
E-mail<\/td>\nEMAIL<\/td>\n<\/tr>\n
Site<\/td>\nSITE<\/td>\n<\/tr>\n
Telefone Celular<\/td>\nTELEFONE-CELULAR<\/td>\n<\/tr>\n
Telefone comercial<\/td>\nTELEFONE-COMERCIAL<\/td>\n<\/tr>\n
Telefone residencial<\/td>\nTELEFONE<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Integra\u00e7\u00e3o da matr\u00edcula e turma<\/h2>\n
Essa api \u00e9 respons\u00e1vel por perguntar ao sistema de terceiro quais s\u00e3o as matr\u00edculas da pessoa.<\/p>\n
[GET]<\/strong>\u00a0http:\/\/sistema.terceiro.com.br\/exemplo.php?api=ApiUnimMoodleCursosMatriculas&cd_pessoa=1554172<\/a><\/p>\n
Par\u00e2metros<\/h3>\n
O LMS vai acrescentar na URL automaticamente o c\u00f3digo da pessoa.<\/p>\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
cd_pessoa<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo da pessoa do sistema de terceiro. Acrescentado automaticamente pelo LMS no momento do login<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Exemplo de como a resposta DEVE ser<\/h3>\n
[\r\n  {\r\n    \"cd_pessoa\" : \"320854\",\r\n    \"cd_moodle_curso\" : \"2\",\r\n    \"cd_curso_disciplina\" : \"82\",\r\n    \"ds_descricao\" : \"CURSO TESTE INTEGRA\u00c7\u00c3O - 06\/05\/2024\",\r\n    \"ds_turma_descricao\" : \"9.5 - 9\u00ba ANO ENSINO FUNDAMENTAL VESPERTINO\",\r\n    \"cd_matricula_situacao\" : \"1\",\r\n    \"ds_curso_md5\" : \"f183246ea1e053cb85a8a753c5bb0e89\",\r\n    \"ds_turma_md5\" : \"8de28bda3b341ce78f044eb05cb02cde\",\r\n    \"ds_metodo_importacao\" : \"parcial\",\r\n    \"cd_avaliacao_tipo\" : \"1\",\r\n    \"sn_separar_turma\" : \"1\",\r\n  },\r\n  {\r\n    \"... pr\u00f3xima matr\u00edcula\"\r\n  }\r\n]\r\n<\/code><\/pre>\n
Campos<\/h3>\n
Abaixo segue a descri\u00e7\u00e3o dos campos.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
cd_pessoa<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo da pessoa<\/td>\n<\/tr>\n
cd_moodle_curso<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo do curso que foi integrado<\/td>\n<\/tr>\n
cd_curso_disciplina<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo da disciplina que foi vinculada no curso EAD<\/td>\n<\/tr>\n
ds_descricao<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nNome do curso para controle interno. N\u00e3o \u00e9 o nome que aparece no LMS. em alguns casos, \u00e9 usado para agrupamento das disciplinas EAD.<\/td>\n<\/tr>\n
ds_turma_descricao<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nNome da turma<\/td>\n<\/tr>\n
cd_matricula_situacao<\/td>\nsmallint<\/td>\nSim<\/td>\n9<\/td>\nC\u00f3digo que define a\u00a0situa\u00e7\u00e3o da matr\u00edcula<\/a><\/td>\n<\/tr>\n
ds_curso_md5<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nDefine a integridade das informa\u00e7\u00f5es do curso. Se alterar o hash ele atualiza o t\u00edtulo do curso.<\/td>\n<\/tr>\n
ds_turma_md5<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nDefine a integridade das informa\u00e7\u00f5es da turma. Se alterar o hash ele atualiza o t\u00edtulo da turma.<\/td>\n<\/tr>\n
ds_metodo_importacao<\/td>\nsmallint<\/td>\nSim<\/td>\nparcial<\/td>\nDefine o m\u00e9todo de importa\u00e7\u00e3o que foi selecionado na integra\u00e7\u00e3o do curso.\u00a0parcial<\/code>,\u00a0media<\/code>\u00a0ou\u00a0nao_importar<\/code>.<\/td>\n<\/tr>\n
cd_avaliacao_tipo<\/td>\nsmallint<\/td>\nSim<\/td>\n1<\/td>\nDefine o c\u00f3digo do tipo de avalia\u00e7\u00e3o que deve voltar para o sistema de terceiro.<\/td>\n<\/tr>\n
sn_separar_turma<\/td>\nsmallint<\/td>\nSim<\/td>\nnull<\/td>\nDefine o tipo de organiza\u00e7\u00e3o das turmas. Mesmo valor escolhido na integra\u00e7\u00e3o do curso.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Tabela de refer\u00eancia para a\u00a0situa\u00e7\u00e3o da matr\u00edcula<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n
C\u00f3digos<\/th>\nSitua\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
-8,3,4,5,6,7,8<\/td>\nCancelada<\/td>\n<\/tr>\n
14,13,12,11,0<\/td>\nConclu\u00eddo<\/td>\n<\/tr>\n
2,18,15,1<\/td>\nCursando<\/td>\n<\/tr>\n
9<\/td>\nReprovado<\/td>\n<\/tr>\n
10,100<\/td>\nReservado<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Total de matr\u00edculas da pessoa<\/h2>\n
[GET]<\/strong>\u00a0http:\/\/sistema.terceiro.com.br\/exemplo.php?api=lms.ApiMatricula&cd_pessoa=219477<\/a><\/p>\n
Par\u00e2metros<\/h3>\n
O LMS vai acrescentar na URL automaticamente o c\u00f3digo da pessoa.<\/p>\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
cd_pessoa<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo da pessoa do sistema de terceiro. Acrescentado automaticamente pelo LMS no momento do login<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Exemplo de como a resposta DEVE ser<\/h3>\n
[\r\n    {\r\n        \"nr_matriculas\": \"1\"\r\n    }\r\n]\r\n<\/code><\/pre>\n
Integra\u00e7\u00e3o da ficha individual<\/h2>\n
[GET]\u00a0http:\/\/sistema.terceiro.com.br\/exemplo.php?api?api=lms.ApiFichaIndividual&dt_base=2024-05-06+17:56:20&cd_coligada=<\/a><\/p>\n
Par\u00e2metros<\/h3>\n
O LMS vai acrescentar na URL automaticamente a data da \u00faltima consulta da fichaindividual.<\/p>\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
dt_base<\/td>\ndate<\/td>\nSim<\/td>\n<\/td>\nData da \u00faltima consulta para otimizar a resposta.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Exemplo de como a resposta DEVE ser<\/h3>\n
A implementa\u00e7\u00e3o do retorno preenchido n\u00e3o \u00e9 obrigat\u00f3ria, por\u00e9m a implementa\u00e7\u00e3o da API sim. Abaixo, apresentamos exemplos tanto preenchidos quanto vazios.<\/p>\n
Preenchido:<\/strong><\/p>\n
{\r\n    \"success\": true,\r\n    \"message\": \"\",\r\n    \"result\": {\r\n        \"fichasindividuais\": [\r\n            {\r\n                \"cd_pessoa\": \"320854\",\r\n                \"nr_anosemestre\": \"20241\",\r\n                \"cd_curso\": \"FUNDAMENTAL II\",\r\n                \"cd_turma_matricula\": \"9.5\",\r\n                \"cd_disciplina\": \"204\",\r\n                \"nr_situacao\": \"3\",\r\n                \"dt_base\": \"2024-05-06 17:50:11\",\r\n                \"id_disciplina\": \"297\",\r\n                \"cd_moodle_curso\": \"2\"\r\n            }\r\n        ],\r\n        \"ds_chave\": \"dev\"\r\n    }\r\n}\r\n<\/code><\/pre>\n
Vazio:<\/strong><\/p>\n
{\r\n    \"success\": true,\r\n    \"message\": \"\",\r\n    \"result\": {\r\n        \"fichasindividuais\": [],\r\n        \"ds_chave\": \"dev\"\r\n    }\r\n}\r\n<\/code><\/pre>\n
Campos<\/h3>\n
Abaixo segue a descri\u00e7\u00e3o dos campos mais relevantes.<\/p>\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
ds_chave<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nChave de acesso ao cliente informada pela equipe de servi\u00e7os<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Integra\u00e7\u00e3o da libera\u00e7\u00e3o financeira do aluno em uma disciplina<\/h2>\n
[GET]\u00a0http:\/\/sistema.terceiro.com.br\/exemplo.php?api?api=lms.ApiLiberacaoCursoLms&cd_pessoa=123456&ds_chave=somente_pessoa<\/a><\/p>\n
Par\u00e2metros<\/h3>\n
O LMS vai acrescentar na URL automaticamente a data da \u00faltima consulta da fichaindividual.<\/p>\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
cd_pessoa<\/td>\ninteger<\/td>\nSim<\/td>\n<\/td>\nC\u00f3digo da pessoa preenchido automaticamente pelo LMS<\/td>\n<\/tr>\n
ds_chave<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nChave fixa que \u00e9 passada do lms para o sistema de terceiro<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Exemplo de como a resposta DEVE ser<\/h3>\n
A implementa\u00e7\u00e3o do retorno preenchido n\u00e3o \u00e9 obrigat\u00f3ria, por\u00e9m a implementa\u00e7\u00e3o da API sim. Abaixo, apresentamos exemplos tanto preenchidos quanto vazios.<\/p>\n
Preenchido:<\/strong><\/p>\n
[\r\n  {\r\n    \"cd_liberacao_curso_lms\" : \"1\",\r\n    \"cd_pessoa\" : \"320854\",\r\n    \"cd_turma\" : \"9.5\",\r\n    \"id_disciplina\" : \"295\",\r\n    \"cd_usuario\" : \"1\",\r\n    \"dt_liberacao\" : \"2024-05-07 16:18:00\",\r\n    \"sn_ativo\" : \"1\",\r\n    \"cd_curso\" : \"FUNDAMENTAL II\",\r\n    \"cd_moodle_curso\" : \"2\"\r\n  }\r\n]\r\n<\/code><\/pre>\n
Vazio:<\/strong><\/p>\n
[\r\n  {}\r\n]\r\n<\/code><\/pre>\n
Campos<\/h3>\n
Abaixo segue a descri\u00e7\u00e3o dos campos mais relevantes.<\/p>\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
ds_chave<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nChave de acesso ao cliente informada pela equipe de servi\u00e7os<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Como logar no LMS<\/h2>\n
[POST]<\/strong>\u00a0->\u00a0https:\/\/lms.unimestre.com\/api\/auth<\/a><\/p>\n
Par\u00e2metros<\/h3>\n\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nPadr\u00e3o<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
user<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nUsu\u00e1rio<\/td>\n<\/tr>\n
password<\/td>\nstring<\/td>\nSim<\/td>\n<\/td>\nSenha<\/td>\n<\/tr>\n
portal<\/td>\nboolean<\/td>\nN\u00e3o<\/td>\nfalse<\/td>\nDefine se o menu superior do LMS deve ser exibido. Normalmente \u00e9 definido como true quando o LMS vai ser exibido embedado.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Par\u00e2metros do header<\/h3>\n\n\n\n\n\n\n
Campo<\/th>\nTipo<\/th>\nObrigat\u00f3rio<\/th>\nDescri\u00e7\u00e3o<\/th>\n<\/tr>\n<\/thead>\n
Api-Token<\/td>\nstring<\/td>\nSim<\/td>\nChave que ser\u00e1 informada ao cliente ap\u00f3s a equipe de servi\u00e7o ter configurado a integra\u00e7\u00e3o.<\/td>\n<\/tr>\n
Api-Cliente<\/td>\nstring<\/td>\nSim<\/td>\nC\u00f3digo do cliente que ser\u00e1 informado ao cliente ap\u00f3s a equipe de servi\u00e7o ter configurado a integra\u00e7\u00e3o.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Exemplo de requisi\u00e7\u00e3o<\/h3>\n
curl --location 'https:\/\/lms.unimestre.com\/api\/auth' \\\r\n--header 'Content-Type: application\/json' \\\r\n--header 'Api-Token: d8dce264b30dbce346ed3754435a652x' \\\r\n--header 'Api-Cliente: uc' \\\r\n--data '{\r\n  \"user\": \"amaiseducacao\",\r\n  \"password\": \"unimestre\",\r\n  \"portal\" : false\r\n}'\r\n<\/code><\/pre>\n
Exemplo de como a resposta DEVE ser<\/h3>\n
{\r\n  \"success\":true,\r\n  \"message\":\"Pessoa encontrada.\",\r\n  \"url\":\"http:\/\/lms.unimestre.com\/dev\/valida-ticket\/NDAzMjQwYTRiY2Nmo=\"\r\n}\r\n<\/code><\/pre>\n
O campo URL \u00e9 para onde o usu\u00e1rio deve ser redirecionado.<\/p>\n
Resultado final<\/h2>\n
Lista de cursos<\/h3>\n
\"\"<\/p>\n
Home do aluno<\/h3>\n
\"\"<\/p>\n
Sala de aula<\/h3>\n
\"\"<\/p>\n
Baixar exemplo em PHP<\/h2>\n
Abaixo \u00e9 poss\u00edvel ver um exemplo de implementa\u00e7\u00e3o de todas as APIs descritas acima.<\/p>\n
Baixar exemplo de implementa\u00e7\u00e3o e Postman\/Insomnia<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Integra\u00e7\u00e3o de sistema de terceiros com estudamais Este artigo tem como objetivo demonstrar como outros sistemas podem se integrar com o Estudamais. O processo de integra\u00e7\u00e3o entre esses dois sistemas segue os modelos de requisi\u00e7\u00e3o e resposta descritos abaixo. A integra\u00e7\u00e3o opera da seguinte maneira: sempre que o LMS enviar uma requisi\u00e7\u00e3o para o sistema […]<\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[93],"tags":[901,79,893],"_links":{"self":[{"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/posts\/12660"}],"collection":[{"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/comments?post=12660"}],"version-history":[{"count":4,"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/posts\/12660\/revisions"}],"predecessor-version":[{"id":12669,"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/posts\/12660\/revisions\/12669"}],"wp:attachment":[{"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/media?parent=12660"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/categories?post=12660"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/unimestresuperior.com\/basedeconhecimento\/wp-json\/wp\/v2\/tags?post=12660"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}