Gestão de portais
Visão Geral
O Dev Portal atua como o portal de acesso ao catálogo de APIs e integrações. Nele são publicadas as documentações para seus consumidores, sejam eles desenvolvedores internos ou parceiros e fornecedores. Ele também 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.
O DHuO oferece a capacidade de gerenciamento de multi-portais e o acesso de cada um é realizado pela URL {endereço da aplicação Dev Portal}/{slug} como, por exemplo, https://devportal.dhuo.io/meu-portal. No DHuO, os slugs são identificadores únicos para portais e compõem as suas URLs. O slug é utilizado para facilitar o uso e a identificação por parte dos usuários.
Os portais no DHuO podem ser personalizados para transmitir a identidade visual dos clientes para os usuários externos. Além disso, é possível controlar o acesso de usuários por meio de fluxos de aprovação.
Configuração
Portais são gerenciados no contexto da Organização. A partir da home, acesse o ícone de configurações da Organização ⚙ menu > Portais. Na página de portais, eles podem ser cadastrados e gerenciados. Ao criar ou visualizar um portal, os dados serão exibidos no estúdio do portal.
Estúdio é uma interface de menus e contextos específicos para o gerenciamento de configurações do portal. No estúdio do portal é possível gerenciar:
- Design (aparência)
- Usuários
- Catálogo de APIs e integrações
- Ambientes
- Consumidores de APIs
Os parâmetros do portal podem ser editados no menu > Configuração no estúdio do portal.
A quantidade de portais permitidos pode ser limitada e está condicionada à licença DHuO adquirida. Para saber mais, acesse a seção Conta de produto e licença.
Permissões
Apenas usuários com papel de administrador da organização (Org Admin) podem gerenciar portais. 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 portal:
- Nome: Obrigatório. Nome do portal.
Os portais são únicos por Organização. Não é possível ter mais de um portal com o mesmo nome.
- Identificador (path ID): Obrigatório. Identificador único (slug) do portal. Utilizado na URL para acesso ao portal. Exemplo: para o identificador
meu-portal, a URL de acesso seráhttps://{endereço do dhuo}/meu-portal.
Por compor a URL de acesso, o identificador do portal (slug) é global e único entre todas as organizações cadastradas na plataforma. Não é possível ter mais de um portal com o mesmo identificador.
- Privacidade: Obrigatório. Determina o tipo de acesso dos usuários ao portal. Opções:
- Público: apenas uma conta de usuário é necessária para acesso ao portal.
- Privado: além de uma conta de usuário, é necessário aprovação para acesso ao portal.
Ao alterar a privacidade de um portal de Público para Privado, os usuários que já tiverem acesso o portal serão considerados aprovados e permanecerão com acesso. O acesso pode ser revogado na administração do portal. Para saber mais, acesse a seção Gerenciamento de usuários.
Da mesma forma, ao alterar a privacidade de um portal de Privado para Público, os usuários que estiverem na lista de pendentes de aprovação serão aprovados automaticamente e terão acesso ao portal.
- Status: Obrigatório. Determina a disponibilidade do portal para os usuários. Opções:
- Online: os usuários poderão acessá-lo e visualizar os catálogos.
- Offline: os usuários não conseguirão acessá-lo. Utilizado em momentos de manutenção do catálogo ou da aparência do portal.
Não é possível excluir um portal caso ele possua consumidores de API cadastrados pelos usuários.
É necessário remover todos os consumidores manualmente para excluir um portal. Para saber mais sobre o gerenciamento de consumidores de APIs, acesse a seção Consumidores de API da Administração do API Manager.
Ao excluir um portal, todos os dados são excluídos permanentemente.