Regras

Altere o comportamento do produto em seu ambiente de homologação ou produção, sem a necessidade de implantar o sistema novamente. O serviço customizado pode ser implementado em qualquer linguagem de programação, desde que ela obedeça aos contratos dos endpoints disponibilizados por um serviço e utilize um dos protocolos disponíveis: SOAP 1.1 ou REST/JSON, ambos HTTP.

Os contratos dos endpoints são disponibilizados na própria interface gráfica, onde é possível configurar as extensões que apontam para os serviços customizados. As customizações são feitas por meio de extensões, sendo permitidos três tipos de extensão na plataforma: funcionalidade, ponto de regra e webhook.

Há três métodos de funcionamento possíveis para as customizações:

• Antes: o serviço customizado receberá a requisição antes de chegar ao serviço de destino e deverá alterar os dados de entrada da requisição, conforme o desejado, e retornar os dados alterados;
• Depois: o serviço customizado receberá a resposta do serviço destino original e deverá alterar o resultado, conforme o desejado, e retornar os dados alterados;
• Interceptar: a requisição será desviada para o serviço customizado que é responsável por tratar os dados de entrada e fornecer os dados de saída adequados. É importante que este método seja utilizado com cuidado, pois o seu uso poderá infringir regras de negócio existente ou até fazer com que o fluxo de outros serviços pare de funcionar adequadamente.

Tipos de cabeçalhos

• Tenant: informações do tenant na chamada;
• User: usuário que está utilizando o serviço. Esta informação pode ser útil para restrições e auditoria, por exemplo;
• 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;
• Token: token de autorização do usuário atual. Permite que outras chamadas de API sejam feitas com esse usuário no código customizado;
• Customizado: permite o customizador passar cabeçalhos com valores fixos para a regra.

Estatísticas

Acompanhe os detalhes da execução das customizações realizadas nas APIs ou nos pontos de regras. Será aberto um painel que contém os dados trafegados, o período, o total de requisições customizadas, a duração da execução, bem como o número de requisições com sucesso, com erro interno, por exemplo o 500, e com erro de chamada, como o 400. Acesse Tecnologia > Customização > Regras > Pontos de regra ou Funcionalidades (API), selecione a primitiva desejada e clique em Ações > Detalhes.

O que você precisa fazer:

Cadastrar uma extensão

1. Acesse Tecnologia > Customização > Regras > Nova customização;
2. Em pesquisar primitivas, busque a primitiva que deseja customizar;
3. Clique em Selecionar no botão de ação da primitiva desejada;
4. Escolha o protocolo (REST ou SOAP 11) utilizado;
5. Selecione o tipo do método;
6. Informe o tipo de histórico que deseja manter;
7. Digite a URL para conexão do serviço de customização. Caso não tenha uma URL para informar, clique em Gerar URL;
8. Adicione tags para facilitar a busca e a identificação da customização. Limite a customização a um usuário, se desejar;
9. Adicione uma descrição para identificação da customização;
10. Em Cabeçalhos HTTP, ative ou desative os cabeçalhos disponíveis e adicione novos em Cabeçalho customizado, se necessário;
11. Clique em Testar conexão para garantir a comunicação da customização;
12. Em seguida, clique em Salvar;
13. Para descartar as alterações, clique em Cancelar.

Importante

Na tela de administração, ative manualmente cada extensão criada para que ela passe a executar.

Realize o teste de conexão fazendo uma chamada Options para a URL informada na customização. É essencial que o serviço customizado esteja preparado para receber essa chamada. A opção para Baixar Swagger ou Baixar WSDL será exibida logo abaixo do protocolo. Ela pode ser baixada e utilizada como contrato a ser seguido durante a customização.

Editar uma extensão

1. Acesse Tecnologia > Customização > Regras > Pontos de regra ou Funcionalidades (API);
2. Clique na caixa de seleção para desativar a customização desejada;
3. Clique em Ações > Editar;
4. Altere todos os campos que forem necessários;
5. Clique em Salvar;
6. Para descartar as alterações, clique em Cancelar.

Importante

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

Excluir extensão

1. Acesse Tecnologia > Customização > Regras > Pontos de regra ou Funcionalidades;
2. Clique na caixa de seleção para desativar a customização desejada;
3. Clique em Ações > Editar;
4. Clique em Excluir;
5. Para descartar as alterações, clique em Cancelar.

Importante

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