Página de Grupos de API no Jitterbit API Manager

Introdução

A página Grupos de API dentro do API Manager permite que um administrador da organização Harmony crie e gerencie um grupo de APIs que usuários externos podem acessar.

Alternativamente, crie e gerencie grupos de API usando o Assistente de IA do APIM.

Para realizar ações ou fazer edições na página Grupos de API, é necessário um papel com permissão Admin. Usuários em papéis com acesso Escrita ao ambiente podem abrir a página, mas não conseguem visualizar o conteúdo.

Acessar a página Grupos de API

Para acessar a página Grupos de API, use o menu do portal Harmony para selecionar API Manager > Grupos de API.

Cabeçalho da página Grupos de API

O cabeçalho na parte superior da página Grupos de API inclui uma caixa de pesquisa e um botão para criar um novo grupo de API:

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

• Novo: Clique para selecionar uma das seguintes opções:

  • Criar com IA: Abre o Assistente de APIM para criar um grupo de API usando comandos em linguagem natural. Para mais informações, veja Usar o Assistente de IA.

    Nota

    Para usar o Assistente de IA do APIM, sua licença Harmony deve incluir a opção do Assistente de IA do APIM. Entre em contato com seu Gerente de Sucesso do Cliente (CSM) para adicionar essa opção à sua licença.

  • Grupo de API: Abre a configuração do grupo de API para criar manualmente um novo grupo de API.

Criar um grupo de API

Quando você seleciona Grupo de API no menu Novo no cabeçalho da página, esta interface do usuário é aberta:

• Nome do grupo de API: Insira um nome para identificar o grupo de API.

• Ambiente: Selecione o ambiente para incluir todas as APIs nesse ambiente no grupo de API.

• API: Um por 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, 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 de API.

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

• Excluir: Clique para excluir o grupo de API.

Visualizar um grupo de API

Ao visualizar um grupo de API, você é apresentado a esta interface do 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.