APIs

Integração via eventos

644 views 04/06/2020 14/09/2020 paulo-weber 0

A Plataforma Senior X possui suporte a integração via eventos, permitindo que quando determinado evento for enviado, seja configurada uma url de serviço para ser chamada para que qualquer serviço possa ser notificado sobre cada chamada de evento. Essa alternativa de integração substitui o as repetitivas consultas a cada intervalo de tempo para verificar se algo mudou, pois quando algo mudar um evento será disparado. Abaixo segue uma ilustração sobre o funcionamento dessa integração

É importante salientar que nem todas as APIs dos serviços da Senior X disparam os eventos informando sobre as alterações, é necessário consultar a lista de APIs publicas do serviço desejado e verificar se o mesmo possui o evento para substituir a consulta. Caso a API que você precisa não tenha suporte a eventos ainda, entre em contato conosco através das formas de contato no fim do post solicitando quais APIs você precisa. Saber quais APIs nossos clientes precisam nos ajudam a priorizar nosso trabalho e entregar primeiro as APIs que os clientes mais precisam.

Criando uma integração via eventos

Existem duas formas de criar essa integração via eventos, de forma manual ou via API, caso seja necessário efetuar a integração em apenas um tenant, ou o usuário esteja testando a ferramenta, descobrindo como funciona é interessante utilizar a forma manual via tela, seguindo a documentação abaixo. Já o cadastro da integração via API é muito útil em situações onde a integração vai acontecer em vários tenants e se torne um processo repetitivo, pois desta forma é possível automatizar esse cadastro diminuindo o tempo de implantação da solução.

Criar integração manualmente

O primeiro passo é abrir a tela de Cadastro de extensões, por padrão a tela está disponível através do menu Tecnologia -> Customização -> Regras -> Nova customização. Após a abertura da tela selecionamos a API que queremos utilizar, neste exemplo é a API usersChanged do serviço de usuários

O segundo passo é configurar a extensão, quando o evento for publicado, que ação vai ser executada? Nesta tela temos duas opções, cadastrar uma url existente, do serviço a ser notificado sobre o evento ou criar uma nova url de serviço utilizando o sdk de desenvolviemnto de customizações. Eventualmente pode ser que nosso serviço a ser integrado seja muito antigo e não seja tão simples criar uma API para receber a chamada do Senior X, nestes tipos de casos, é possível criar um serviço intermediário que faça a conversão, recebendo a chamada da Senior X e repassando para o serviço legado de acordo com o padrão do mesmo, para estas situações, temos o sdk de desenvolvimento de customizações, onde podemos criar um serviço e disponibilizar na AWS sem se preocupar com questões de servidor, hardware, escalabilidade, etc. Clique aqui para acessar o tutorial sobre a criação do ambiente de customizações na cloud.

Exemplo de configuração para chamar um serviço para efetuar a integração:

 

Criar integração utilizando APIs

Antes de criar a integração utilizando APIs é necessário efetuar o login pra passar o token de autenticação nas chamadas subsequentes. Consulte o tutorial sobre consumo de uma API para aprender a efetuar o login e passar o header de autenticação nas chamadas. Para criar a integração é necessário executar um POST na url https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/platform/rules/entities/endpointExtension , abaixo disponibilizamos um exemplo de corpo da requisição.

 

Encontrou alguma dúvida no meio do caminho? Temos um fórum onde as dúvidas podem ser postadas e alguém irá lhe ajudar, clique aqui para acessá-lo.

Este artigo foi útil para você?