Grupos de API¶
Introdução¶
A página Grupos de API no API Manager permite que um administrador da organização Harmony para criar um grupo de APIs que usuários externos pode acessar.
Para executar ações ou fazer edições na página Grupos de API, é necessária uma papel com permissão Admin. Os usuários em funções com acesso ao ambiente Write podem abrir a página, mas não podem visualizar o conteúdo.
Acesse a Página de Grupos de API¶
A página Grupos de API pode ser acessada no menu do Harmony Portal ou em outras páginas do API Manager:
-
Da Casa ou Downloads ou nas páginas Cloud Studio, Vinyl, Marketplace, Management Console, EDI, ou Citizen Integrator, use o menu Harmony Portal no canto superior esquerdo para ir para API Manager > API Groups:
-
Em Minhas APIs, Gerenciador do Portal, Registros de API, Análise, Perfis de segurança ou Grupos de IPs Confiáveis, use o menu de navegação do API Manager para selecionar Grupos de API:
Cabeçalho da Página de Grupos de API¶
O cabeçalho na parte superior da página Grupos de API inclui navegação no API Manager, uma caixa de pesquisa e um botão para criar um novo grupo de API:
-
Navegação: Use o menu de navegação do API Manager para navegar para outras páginas na interface do usuário do API Manager.
-
Pesquisa: Insira qualquer parte do nome de um grupo de API na caixa de pesquisa para filtrar grupos de API por nome. A busca não diferencia maiúsculas de minúsculas.
-
Adicionar grupo: Clique para criar um novo grupo de API.
Crie um Grupo de API¶
Ao clicar no botão Adicionar grupo no cabeçalho da página, você verá esta interface de usuário:
-
Nome do grupo de API: Insira um nome para identificar o grupo de API.
-
Ambiente: Selecione o ambiente para incluir todas as APIs desse ambiente no grupo de API.
-
API: Uma de cada vez, selecione uma API para incluir no grupo de API. Clicar no nome de uma API individual revela informações adicionais sobre a API no painel direito, como a versão da API, o URL do serviço e as operações atribuídas à API.
-
Salvar: Clique para salvar o grupo de API e fechar a configuração.
-
Cancelar: Clique para descartar o grupo de API e fechar a configuração.
Grupos de API¶
Os grupos de API existentes são exibidos da seguinte forma e têm estas opções:
-
Visualizar: Clique no triângulo de divulgação
para ver detalhes adicionais sobre o grupo de API.
-
Editar: Clique no ícone de edição
para adicionar ou remover as APIs no grupo de API.
-
Excluir: Clique no ícone de exclusão
para excluir o grupo de API.
Ver um Grupo de API¶
Ao visualizar um grupo de API, você verá esta interface de usuário:
-
API: O nome da API.
-
Versão: A versão da API.
-
Ambiente: O ambiente da API.
-
Caminho: O prefixo da URL, a versão da API e a raiz do serviço do URL do serviço da API.
-
Copiar: Clique no ícone de cópia
para copiar o Path para sua área de transferência.