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 API Groups, é necessária uma papel com permissão Admin. 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 Grupos de API

A página Grupos de API pode ser acessada pelo menu do portal Harmony ou pelo menu de navegação do API Manager:

• Use o menu do portal Harmony para selecionar API Manager > API Groups:

  

• Ao acessar uma página do API Manager, use seu menu de navegação para selecionar Grupos de API:

  

Cabeçalho da Página 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 dentro do API Manager.

• Pesquisar: Insira qualquer parte do nome de um grupo de API na caixa de pesquisa para filtrar grupos de API por nome. A pesquisa não diferencia maiúsculas de minúsculas.

• Adicionar grupo: Clique para criar um novo grupo de API.

Criar 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: Selecione uma API de cada vez 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, a 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 para ver detalhes adicionais sobre o grupo API.

• Editar: Clique para adicionar ou remover as APIs no grupo de API.

• Excluir: Clique para excluir o grupo de API.

Exibir 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 da URL do serviço da API.

• Copiar: Clique para copiar o Caminho para sua área de transferência.