Ir para o conteúdo

Página de Grupos de API no Jitterbit API Manager

Introdução

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

Como alternativa, 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 ter uma função com permissão de Admin. Usuários em funções com acesso de ambiente Write 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 no topo da página Grupos de API inclui uma caixa de pesquisa e um botão para criar um novo grupo de API:

header

  • Pesquisar: Digite 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, com a porção de texto correspondente destacada.

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

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

      Nota

      Para usar o Assistente de IA do APIM, sua licença Harmony deve incluir a opção Assistente de IA do APIM. Entre em contato com seu Gerenciador 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

Ao selecionar Grupo de API no menu Novo no cabeçalho da página, esta interface de usuário é aberta:

add new group

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

  • Ambiente: Selecione o ambiente para incluir todas as APIs naquele 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, 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

Grupos de API existentes são exibidos como segue e têm estas opções:

API groups

  • Visualizar: Clique para visualizar 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, esta interface de usuário é apresentada:

view API groups

  • API: O nome da API.

  • Versão: A versão da API.

  • Ambiente: O ambiente da API.

  • Caminho: O prefixo de URL, versão da API e raiz do serviço da URL do serviço de API.

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