Regras e Extensão de Funcionalidades

Utilização de WebHook para eventos

37 views 23/10/2019 lucas-schepers 0

Funcionalidades expostas como eventos na plataforma tem como modelo de customização o padrão de webhook, que apesar de ser cadastrado da mesma forma que outras customizações tem como diferença:

  • não executar nos mesmos momentos (antes/depois/interceptando), e sim como um assinante do evento;
  • poder ser cadastrado mais de uma extensão para o mesmo evento;

O primeiro ponto indica que uma extensão para um evento não interfere na execução do mesmo, ao contrário das outras extensões.

Existe um limite em quantas extensões podem ser cadastradas em um evento, sendo o valor padrão 10. Apenas o tenant master pode alterar esse valor.

Abaixo disponibilizamos os passos necessários para configuração de uma customização na plataforma Senior X.

As páginas de configuração de extensões estão disponíveis em Tecnologia > Customização > Regras > Nova customização.

Cadastrar uma extensão

  • Na tela de ‘Pesquisar primitivas’ busque a primitiva que deseja customizar.
  • Clique em Selecionar no botão de ação da primitiva acima.
  • Com a primitiva selecionada escolha o protocolo (REST ou SOAP 11) utilizado.
  • Selecione o tipo de histórico que deseja armazenar.
  • Digite a URL para conexão do serviço de customização, ou clique em Gerar URL para utilizar o ambiente de customização SDK.
  • Adicione uma descrição para identificação da customização.
  • Clique em Avançar.
  • Em cabeçalho padrão, ative ou desative os headers conforme a necessidade, e adicione novos em cabeçalhos customizados, se necessário.
    • Cabeçalho Tenant > Informação do tenant que o endpoint está fazendo a chamada.
    • Cabeçalho User > Traz o usuário que está utilizando o serviço, esta informação pode ser útil para restrições e auditoria por exemplo.
    • Cabeçalho Timeout > Responsável por informar o tempo de resposta hábil do serviço, pode ser usado para configurar mensagens de erro caso a resposta demore para ocorrer.
    • Cabeçalho Token > Token de autorização do usuário atual, permite que outras chamadas de API sejam feitas com este usuário no código customizado.
    • Cabeçalho Customizado > Pode ser utilizado conforme a necessidade, possui um valor fixo, pode ser utilizado para controle.
  • Clique em Testar conexão para garantir a comunicação da customização.
  • Após clique em Salvar.
  • A qualquer momento clique em Cancelar para descartar as alterações.

Abaixo seguem alguns detalhes importantes:

  • Uma extensão após ser criada estará desativada, e é necessário ativá-la manualmente na tela de administração para que ela passe a executar.
  • teste de conexão é realizado fazendo uma chamada OPTIONS para a URL informada na customização, portanto é essencial que quem estiver customizando implemente a mesma no serviço customizado, só assim poderá ser validada.
  • A opção para Baixar Swagger ou Baixar WSDL será exibida logo abaixo do protocolo, pode ser baixada e utilizá-la como contrato a ser seguido durante a customização.

As páginas de configuração das customizações em caso de WebHook estão disponíveis em Tecnologia > Customização > Regras > Funcionalidades (API).

Editar uma extensão

  • Desative a customização desejada.
  • Clique em Ações > Editar.
  • Altere todos os campos que forem necessários.
  • Clique em Salvar.
  • A qualquer momento clique em Cancelar para descartar as alterações.

Excluir módulo

  • Desative a customização desejada.
  • Clique em Ação > Editar.
  • Clique em Excluir.
  • A qualquer momento clique em Cancelar para descartar as alterações.

 

Importante: Uma extensão apenas pode ser alterada ou excluída se não estiver ativa.

Este artigo foi útil para você?