Credenciais API Key
Visão Geral
Por estarem relacionados ao acesso a APIs, a identificação de um consumidor está atrelada a uma credencial. As credenciais são necessárias para autenticar os consumidores por meio de um mecanismo de autenticação. Portanto, se uma API é protegida por um mecanismo de autenticação, é necessário possuir um consumidor e credenciais correspondentes ao tipo de autenticação para acessá-la.
Basicamente, uma API protegida por autenticação Key Authentication requer uma credencial composta por uma API key. Uma vez configuradas no DHuO, essas credenciais podem ser enviadas nas requisições para validação no API Gateway.
Para que a identificação do consumidor e validação da credencial funcionem, é necessário que o mecanismo de autenticação Key Authentication esteja configurado na API. Para saber mais sobre como configurar Key Authentication em uma API, acesse a seção Key Authentication da lista de plugins do API Gateway DHuO e Kong.
Configuração
As credenciais são criadas no contexto do consumidor de APIs. A partir da home, acesse o ícone de configurações da Organização ⚙ menu > Consumidores. Na página de consumidores, acesse a opção Credenciais do consumidor desejado. Na página seguinte, acesse o menu > API Key.
Para criar uma credencial, é necessário possuir um consumidor cadastrado. Para saber mais sobre consumidores de API, acesse a seção Consumidores de API da Administração do API Manager.
Um consumidor pode ter mais de uma credencial, porém apenas uma credencial por tipo de autenticação.
Permissões
Apenas usuários com papel de administrador da organização (Org Admin) ou operador de APIs (API Operator) podem gerenciar credenciais de consumo. Para saber mais, acesse a seção Papéis e permissões.
Parâmetros
Aqui estão os parâmetros para configuração de uma credencial API Key:
- Chave: Obrigatório. A chave a ser usada na autenticação do consumidor nas requisições de API. Caso não seja informado um valor, uma chave será gerada automaticamente.
Não é possível alterar uma credencial após a criação. Caso seja necessário alterar uma credencial, é preciso removê-la e criar uma nova.
Ao excluir uma credencial, os acessos às APIs das aplicações que a utilizam deixarão de funcionar até que novas credenciais sejam criadas e as aplicações sejam atualizadas com os novos valores.