• O que é API Key (chave de segurança)


Credencial de acesso fornecida para consultas em pipelines que utilizam os triggers mencionados acima. Esta é a garantia mínima de segurança exigida. 

obs: Recomendamos que, além da utilização de API Key (e sempre que possível), a segurança seja reforçada com o uso de JWT (JSON Web Token).

__________________________________________________________________

  • Como configurar API Key na plataforma Digibee

  1. Acesse o menu CONFIGURAÇÕES e selecione a aba API Keys, como mostrado abaixo:

2. Selecione o ambiente e clique em "CRIAR";

3. No campo API Key, escolha um nome para a API Key e, na sequência, selecione os pipelines que utilizarão essa autenticação (campo ACLS). Confirme a configuração.

Um hash de caracteres alfanuméricos será gerado e exibido na coluna CHAVES DE API. A coluna ACLS conterá o nome do pipeline atrelado à API Key gerada.

Obs: o botão AÇÕES pode ser utilizado para visualizar e editar a lista de pipelines que utilizarão esta API Key.

Recomendação: gere uma API Key diferente para cada sistema consumidor de sua API, restringindo o acesso somente aos pipelines desejados.

_________________________________________________________________

  •  Como utilizar a API Key em requisições direcionadas para o pipeline exposto

  1. Esta chave deverá ser enviada no header, com o parâmetro "apikey", e seu respectivo valor. Informe também o Content-Type esperado pelo pipeline (Ex: application/json):

2. Outra opção (caso não seja possível alterar o header da chamada no sistema legado), é incluir a API Key como parâmetro de chamada na url. Esta, porém, não é uma opção segura para serviços expostos. Neste caso, garanta que apenas o serviço autorizado poderá chamar a API exposta pela Digibee (controle de consumers).

Encontrou sua resposta?