Skip to main content

Ambientes

Visão Geral​

O Dev Portal do DHuO possui a capacidade de criação e gerenciamento de credenciais de acesso de APIs, para os usuários conseguirem consumir APIs protegidas por mecanismos de autenticação.

Os ambientes de portal existem para possibilitar esse gerenciamento autossuficiente de credenciais por parte dos usuários do portal. Uma API pode estar disponível em diversos ambientes (como produção, sandbox, entre outros) e pode estar protegida por diferentes mecanismos de autenticação. Logo, os ambientes são configurados relacionando o ambiente do API Gateway onde estão implantadas as APIs publicadas no portal com os tipos de credenciais permitidas para criação por parte dos usuários.

O DHuO possibilita a criação de credenciais para os seguintes tipos de autenticação:

  • Basic Authentication
  • Key Authentication
  • JWT Authentication
Informação adicional

O Dev Portal não é o único meio para geração de credenciais de acesso de APIs. Esta funcionalidade de autosserviço para geração de credenciais é recomendada para ambientes internos e não produtivos. Para ambientes produtivos, recomenda-se gerar credenciais pela interface de gerenciamento de APIs e integrações (Manager).

Por exemplo, um portal interno destinado ao time de desenvolvimento pode exibir as documentações de APIs que estão em fase de desenvolvimento e testes. Para os desenvolvedores terem mais liberdade e agilidade para consumir as APIs desses ambientes, pode ser habilitado a geração de credenciais para os mesmos conseguirem gerar as credenciais por conta própria, pelo próprio portal. Para saber mais, acesse a seção Consumidores de API da Administração do API Manager.

Configuração​

Os ambientes de API do portal são gerenciados pela interface do estúdio do portal. A partir da home, acesse o ícone de configurações da Organização ⚙ menu > Portais. Na página de portais, visualize o portal desejado e acesse o menu > Ambientes.

Permissões​

Apenas usuários com papel de administrador da organização (Org Admin) podem gerenciar ambientes de API do portal. Para saber mais, acesse a seção Papéis e permissões.

Parâmetros​

Aqui estão os parâmetros para configuração de um ambiente do portal:

  • Ambiente: Obrigatório. Ambiente onde se encontra o API Gateway que será relacionado ao portal.
  • Gateway: Obrigatório. API Gateway que será relacionado ao portal.
  • Permissão de criação de credenciais: Obrigatório. Escolha entre permitir ou negar que o API Gateway relacionado ao portal estará disponível para os usuários criarem suas próprias credenciais de acesso às APIs.
  • Basic Auth: Obrigatório. Escolha entre permitir ou negar que os usuários do portal possam criar credenciais de acesso para APIs que possuem autenticação do tipo Basic Authentication.
  • API Key: Obrigatório. Escolha entre permitir ou negar que os usuários do portal possam criar credenciais de acesso para APIs que possuem autenticação do tipo Key Authentication.
  • JWT: Obrigatório. Escolha entre permitir ou negar que os usuários do portal possam criar credenciais de acesso para APIs que possuem autenticação do tipo JWT Authentication.
Atenção!

Ao excluir um ambiente ou alterar os tipos de credenciais permitidas para criação no portal, as credenciais existentes não são removidas. Apenas a opção de criação de novas credenciais é removida.

As credenciais geradas por usuários do portal são gerenciadas e podem ser excluídas pela interface de gerenciamento de APIs e integrações (Manager). Para saber mais, acesse a seção Consumidores de API da Administração do API Manager.