Consumidores de API
Visão Geral
Consumidor é uma entidade que representa um indivíduo ou aplicação que consumirá recursos de uma API. A partir da identificação de consumidores é possível proteger e restringir o acesso às APIs com mecanismos de autenticação, autorização e políticas de controle de acesso (ACL). Com isso é possível também monitorar o uso das APIs e impor limites de consumo para cada consumidor.
Por estarem relacionados ao acesso a APIs, a identificação de um consumidor está condicionada a dois fatores:
- A existência de um mecanismo de autenticação configurado na API
- A existência de uma credencial de acesso à API válida, vinculada ao consumidor
Para saber mais sobre credenciais de acesso a APIs, acesse a seção Credenciais de acesso do Dev Portal.
Dado que uma API pode estar disponível em diversos ambientes (como produção, sandbox, entre outros), o consumidor tem uma identidade única para cada ambiente disponível da API. No cenário anterior, é necessário ter um consumidor específico para o ambiente de sandbox e outro para o ambiente de produção.
É necessário habilitar a opção de criação de credenciais no portal para que a página de consumidores de APIs esteja visível. Para saber mais sobre como configurar essa opção, acesse a seção Ambientes da Administração do Dev Portal.
Configuração
Os consumidores são configurados de acordo com o ambiente das APIs disponíveis no portal. A partir da home, acesse o menu > Consumidores de APIs. Na página de consumidores, eles podem ser cadastrados, editados e excluídos.
Parâmetros
Aqui estão os parâmetros para configuração de um consumidor de APIs:
- Nome: Obrigatório. Nome do consumidor.
Os consumidores são únicos por ambiente. Não é possível ter mais de um consumidor com o mesmo nome em um mesmo ambiente.
- Ambiente: Obrigatório. Ambiente no qual estão as APIs que o consumidor terá acesso.
Não é possível alterar o ambiente após a criação do consumidor. Caso seja necessário alterar o ambiente, é preciso remover o consumidor e criar um novo no ambiente desejado.
Ao excluir um consumidor, todas as credenciais de acesso associadas serão removidas e, consequentemente, o acesso às APIs.