Após o aplicativo da integração já estar instalado no ambiente da instituição é necessário realizar algumas configurações iniciais para seu funcionamento. Neste documento será abordado as configurações para a comunicação com a API do Captação, API do Lyceum, mapeamentos e parâmetros específicos.
Primeiramente, no menu lateral, clique em Integrações.
Em seguida, clique em Integração Lyceum.
Configurações API Captação
A primeira configuração necessária a ser feita e que não depende qualquer outra é a configuração de acesso a API do Captação. Isso faz-se necessário pois a integração desenvolvida utiliza tal API para realizar a busca dos dados e alterações nas inscrições.
Endereço (URL): Esse campo deve ser preenchido com o endereço da Api Ficha de Inscrição. Por exemplo http://inscricaotime1-dev1.azurewebsites.net/api.
Usuário: Usuário de integração do CRM ou usuário licenciado do Dynamics.
Nova Senha: Esse campo é usado para salvar a senha do usuário. Por questões de segurança não retornamos a senha no formulário. O campo deve ser preenchido apenas na primeira configuração ou quando quiser sobrescrever a senha que estiver salva em nossa base.
Tipo Concessão: Usar a opção password.
Tipo Autenticação: Utilizar APICRMEducacional para usuário de integração ou CRM para usuário autenticado do Dynamics.
Timeout (segundos): Pode ser preenchido com qualquer valor maior que zero. Caso fique em branco usará o padrão de 100 segundos.
Após salvar uma configuração, para testar o funcionamento basta clicar no botão testar acesso.
Em caso de erro verifique os dados de endereço, usuário e senha informados.
Configurações API Lyceum
Estas configurações são para a comunicação com a API do Lyceum.
Endereço (URL): Esse campo deve ser preenchido com o endereço da API do Lyceum.
Usuário: É o usuário criado no Lyceum para realizar as operações da integração.
- Nova Senha: Esse campo é usado para salvar a senha do usuário. Por questões de segurança não retornamos a senha no formulário. O campo deve ser preenchido apenas na primeira configuração ou quando quiser sobrescrever a senha que estiver salva em nossa base.
Timeout (segundos): Pode ser preenchido com qualquer valor maior que zero. Caso fique em branco usará o padrão de 100 segundos.
Após salvar uma configuração, para testar o funcionamento basta clicar no botão testar acesso.
Em caso de erro verifique os dados de endereço, usuário e senha informados.
Mapeamentos
Os mapeamentos servem para criar vínculos entre as informações dos dois sistemas. Assim toda vez que for enviado um ingresso para o SGA será utilizado esses mapeamentos para montar os dados a serem enviados.
Entidade SGA: Este campo é de preenchimento obrigatório. Selecione uma das entidades que receberá a informação do mapeamento, considerando o que está disponível no documento de integração disponibilizado pela equipe do Lyceum.
Campo SGA: Este campo é de preenchimento obrigatório. Digite o nome do campo que receberá a informação do mapeamento, considerando o que está disponível no documento de integração disponibilizado pela equipe do Lyceum.
Entidade CRM: Este campo é opcional, caso seja utilizado valor padrão. Selecione uma das entidades que será a origem da informação no mapeamento.
Campo CRM: Este campo é opcional, caso seja utilizado valor padrão. Selecione uma das entidades que será a origem da informação no mapeamento.
Ordem: Este campo é de preenchimento obrigatório. Ele serve para ordenar a sequência que será utilizada para mapear um campo caso tenha dois ou mais mapeamentos para o mesmo campo SGA. Por padrão utilize sempre o valor 1.
Tipo de Registro: Este campo deve ser preenchido caso tenha selecionado as entidades SGA “pessoa” ou “enderecoPessoa”. Valores possíveis: Aluno, Responsável Financeiro e Responsável Acadêmico.
Valor Padrão: Este campo é opcional. Caso queria mapear uma informação padrão com o SGA que não tenha vínculo com o CRM basta deixar os campos de entidade CRM e campo CRM em branco e preencher um valor padrão para o campo SGA. Outra situação possível é criar o mapeamento normal e preencher este campo com um valor padrão, neste caso, se o valor indo do CRM esteja em branco será utilizado o valor padrão na integração.
Tipo Conversão: Utilizado para manipular a informação antes dela ser enviada para o SGA, por exemplo, ao mapear o campo CPF do lead ele vem com máscara, porém no SGA ele deve ser salvo sem máscara, desta forma utilizamos a opção “SomenteNumeros” que irá remover qualquer caractere que não seja número.
Somente Números: Remove qualquer caractere que não seja número.
Feminino/Masculino: Preenche com F ou M caso a informação seja Feminino ou Masculino.
Sim/Não: Preenche com S ou N caso a informação seja Sim ou Não.
DePara: Habilita um novo campo na tela para criar um de/para de valores. Neste campo preencha um JSON com os valores conforme exemplo: {"Cartão de Débito":"Debito","Cartão de Crédito":"Cartao"}. O valor da esquerda será o valor vindo do CRM e o valor da direita será o valor que será enviado para o SGA.
Tudo Maiúsculo: Converte todos os caracteres para maiúsculo antes de enviar para o SGA.
Tudo Minúsculo: Converte todos os caracteres para minúsculo antes de enviar para o SGA.
Em caso de instalação nova, faz necessário executar um método na API para popular esses mapeamentos com uma configuração padrão, neste caso acesse o item Métodos API, que está no menu superior, e executar o método “/api/{organizacaoId}/Mapeamentos/CriarPadroes”.
Parâmetros
Deve ser utilizado para incluir parâmetros específicos criados para o produto.
Integrar Pagamento
Este parâmetro serve para habilitar o envio dos dados de pagamento da taxa de matrícula na integração SGA.
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo