Ir para o conteúdo

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 um grupo de APIs que usuários externos podem acessar.

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 Write 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:

header

  • Pesquisar: Insira qualquer parte do nome de um grupo de API na caixa de pesquisa para filtrar os grupos de API pelo 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ê é apresentado a esta interface do usuário:

add new group

  • 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 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

Os grupos de API existentes são exibidos da seguinte forma e têm estas opções:

Grupos de API

  • 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:

visualizar grupos de API

  • API: O nome da API.

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

  • Ambiente: O ambiente da API.

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

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