Boas práticas para a construção de um pipeline

Siga estas boas práticas para garantir que seus pipelines sejam seguros, eficientes e bem estruturados.

Antes de publicar um pipeline, revise estes pontos-chave para proteger seus fluxos de integração:

Use chaves de API

Se o seu pipeline incluir os triggers HTTP, REST ou HTTP File, os serviços criados ficarão expostos à internet. Para aumentar a segurança, a Digibee Integration Platform exige que esses triggers sejam usados com uma chave de API por padrão. Saiba como criar uma chave de API.

Use uma chave de API separada para cada sistema que consome uma API e restrinja o acesso apenas aos pipelines necessários.

Para maior segurança, recomendamos implementar a autenticação JWT (JSON Web Token).

Exceção: Se precisar publicar um pipeline com esses triggers sem uma chave de API (não recomendado), solicite via chat usando o seguinte modelo:

Solicito a inclusão dos seguintes pipelines na whitelist para não exigir chave de API.

• Nome do realm

• Nomes dos pipelines a serem incluídos na whitelist do realm

• Motivo da solicitação

Armazene nomes de usuário e senhas com segurança

Nunca exponha credenciais de login diretamente na configuração dos conectores. Em vez disso, armazene-as na página Contas e faça referência a elas no formulário de configuração do conector.

Oculte campos sensíveis

Configure os campos sensíveis nas configurações do pipeline ou na Política de Campos Sensíveis para ocultá-los automaticamente nos logs e mensagens. Isso evita a exposição de dados durante a integração, reduzindo riscos de segurança. Os campos ocultados são substituídos por "***".

Use HTTPS em vez de HTTP

Sempre que possível, use HTTPS para chamadas a serviços externos para aumentar a segurança.

Criptografe e limpe os dados do Object Store

• Criptografe dados sensíveis armazenados em um Object Store usando conectores de criptografia.

• Limpe periodicamente o Object Store. Ele é um banco de dados auxiliar para o desenvolvimento de fluxos de integração e não deve armazenar grandes volumes de dados. Se não for limpo regularmente, pode causar falhas nos fluxos de integração.

Use o conector Script apenas quando necessário

O conector Script (JavaScript) roda em uma infraestrutura separada fora do pipeline. Isso pode tornar o processamento mais lento e, como essa infraestrutura é compartilhada, o uso excessivo pode causar atrasos em vários pipelines.

Para evitar esses problemas, sempre que possível utilize conectores dedicados, como Transformer (JOLT), JSLT, JSON Transformer e JSON Generator (Mock) para transformação e mapeamento de dados. Esses conectores são incorporados ao pipeline e oferecem melhor desempenho. Utilize o Script (JavaScript) apenas quando for a única opção viável.

Não tem certeza se precisa do conector Script (JavaScript)? Fale com nosso time. Podemos ter uma solução melhor com outros conectores.

Valide as respostas de serviços externos

Ao integrar com serviços externos, como APIs ou bancos de dados, sempre verifique se o tipo de resposta está dentro do esperado. Caso não esteja, tome as ações necessárias, como reprocessar ou tratar o erro.

Para mais detalhes, consulte nossa documentação sobre arquitetura orientada a eventos.