Política de acesso à APIs externas

Saiba mais sobre a Política de acesso à APIs externas da Digibee Integration Platform.

O acesso à APIs externas é um padrão de segurança usado para chamadas de API que permitem acesso seguro aos pipelines pela Internet via protocolo HTTP.

Você pode escolher entre 3 opções para cada ambiente, como descrito abaixo:

  • Uso obrigatório somente de chave de API: todos os pipelines que usam um trigger que exponha o seu pipeline a chamadas externas devem utilizar uma chave. Habilite essa opção ao configurar um trigger.

  • Uso obrigatório de JWT com chave de API: todos os pipelines que usam um trigger que exponha o seu pipeline a chamadas externas devem usar um token JWT e também uma chave de API.

  • Qualquer tipo de autenticação permitida: esta opção permite aos desenvolvedores escolher o tipo de autenticação, mas nenhuma autenticação é obrigatória. Recomendamos o uso de pelo menos uma das opções acima.

Confira na imagem abaixo como visualizar as alternativas e selecionar uma para cada ambiente.

Como funciona

Uma vez configurada a sua Política de acesso à APIs externas, cada novo pipeline deve seguir as regras de acordo com as suas definições. Caso a política não seja aplicada, a pessoa que criou o pipeline será lembrada durante a fase de implantação. Em outras palavras, não é possível implantar o pipeline até a correção do problema.

Para saber mais sobre conceitos, visite o artigo Políticas.

Para habilitar sua API Key ou seu Token JWT no trigger de seu pipeline, ative o botão conforme imagem abaixo:

Criando sua Chave de API

Agora que você tem sua política e um pipeline configurado para usar uma Chave de API, você pode criar uma nova chave ou usar uma já existente ao acessar a página Consumers (Chaves de API) no menu Configurações.

Depois de criar sua chave de API, lembre-se de associá-la ao seu pipeline em ambos os ambientes.

Saiba mais na documentação de Consumers (Chaves de API).

Criando seu Token JWT

Ao optar pelo uso de Tokens JSON Web, é preciso criar um segundo pipeline que funcionará como seu fluxo de login. O fluxo de login vai gerar o JWT que será utilizado em suas chamadas de API.

Saiba mais sobre implementação na documentação de Digibee JWT (Generate and Decode).

Last updated