Página de APIs no Jitterbit API Manager

Introdução

A página APIs é a página de aterrissagem do API Manager e fornece aos administradores da organização Harmony a capacidade de gerenciar APIs personalizadas, Serviços OData e APIs proxy criado por meio do API Manager.

Membros de uma papel que recebeu Read acesso ao ambiente também pode acessar a página APIs para APIs naquele ambiente. Membros de uma papel que recebeu Write acesso ao ambiente tem acesso de gravação nesse ambiente.

Para acessar a página APIs, faça login no portal Harmony, então use o menu do portal Harmony no canto superior esquerdo para ir para API Manager > APIs:

Certifique-se de que você está acessando a organização desejada, que pode ser alterada na barra de navegação superior (veja Alterando a organização selecionada no portal Harmony).

Cabeçalho da página APIs

O cabeçalho na parte superior da página APIs inclui estes controles:

• URL base: A URL base da API da organização Harmony.

• URLs de API customizada usadas: O número de URLs de API personalizadas usadas atualmente do número total de URLs de API personalizadas permitidas pela assinatura da organização. URLs de API usadas atualmente consistem naquelas usadas por APIs personalizadas e OData publicadas e seus clones publicados. APIs de rascunho não contam como URLs de API em uso.

• URLs de proxy de API usadas: O número de URLs de API de proxy usadas atualmente do número total de URLs de API de proxy permitidas pela assinatura da organização. URLs de API de proxy usadas atualmente consistem naquelas usadas por APIs de proxy publicadas e seus clones publicados. APIs de rascunho não contam como URLs de API em uso.

• Filtro: Abre um painel com controles para filtrar a tabela por Tipo de API, Status da API, Grupo de API, Ambiente, Perfil de segurança e datas de Última edição e Última publicação:

  

  Os filtros são aplicados imediatamente. Use os botões Limpar ou Limpar tudo para redefinir os filtros e o Botão Fechar para fechar o painel.

• Pesquisar: Insira qualquer parte do nome da API, versão, ambiente, tipo, descrição, status ou a data ou hora em que a API foi publicada ou editada pela última vez na caixa de pesquisa para filtrar a lista de APIs (somente caracteres alfanuméricos). A pesquisa não diferencia maiúsculas de minúsculas.

• Visualizar: Clique no vista em ficha ou visualização de lista ícone para alternar o formato usado para exibir APIs nesta página. A visualização em mosaico é a visualização padrão inicial. Na próxima vez que você carregar a página APIs, a última visualização selecionada será pré-selecionada.

• Importar API: Abre a tela de importação de API, onde você pode importar APIs em formato APK (consulte Exportando e importando APIs).

• Exportar API: Abre a tela de exportação de API, onde você pode exportar APIs selecionadas no formato APK (consulte Exportando e importando APIs).

• Novo: Use o menu para selecionar o tipo de API a ser criado, seja API customizada ou proxy de API:

  • API customizada: (disponível somente se houver uma URL de API personalizada disponível.) Abre a tela de configuração da API para criar uma nova personalizada ou OData API.

  • proxy de API:(Disponível somente se houver uma URL de API de proxy disponível.) Abre a tela de configuração da API de proxy para criar um novo proxy API.

Visualização em mosaico

Para acessar a visualização em ficha, selecione Ícone de Visualização em mosaico.

A visualização de blocos exibe APIs como blocos. Cada ficha tem uma frente e um verso que podem ser "virados" para revelar informações e ações adicionais da API. A frente é exibida por padrão. O verso é exibido ao passar o mouse sobre o ficha:

• Frente: A frente do ficha mostra o nome da API, versão, ambiente, tipo de API (Personalizado, OData ou Proxy), status da API (Publicado, Publicado com Rascunho ou Rascunho) e última edição ou data da última publicação (em MM/DD/YY formato) no horário local do navegador. A cor do ícone à esquerda do status da API indica a categoria do status da API:

  Ícone	Cor	Categoria
  	Verde	A API está publicada.
  	Amarelo	A API é publicada com um rascunho.
  	Open Green	A API é um rascunho.

• Voltar: O verso do ficha (visível ao passar o mouse sobre um ficha) mostra o nome da API, o ambiente, a descrição da API e o nome do usuário que editou a API pela última vez. Além disso, estas ações estão disponíveis:

  • Exibir/Editar: Abre a tela de configuração da API (consulte Configuração de API customizada, Configuração do serviço OData, ou Configuração da proxy de API).

  • Ações: Clique no ícone do menu de ações para abrir um menu com estas ações:

    Item de menu da API	Descrição
    	Logs da API abre os Logs da API, que exibe logs de processamento e depurar (se o log de depurar estiver habilitado) para todas as APIs.
    	Analytics abre o Analytics, que exibe métricas de consumo e desempenho para todas as APIs.
    	Clone abre a tela de configuração da API (veja Configuração de API customizada, Configuração do serviço OData, ou Configuração da proxy de API), pré-preenchido com os detalhes de configuração da API clonada e padrões atualizados para estes campos: Nome da API: O nome da API é prefixado com Cópia de. Raiz do serviço: A raiz do serviço é prefixada com Cópia de. Versão: A versão é anexada com -2. Este número não é incrementado com clones adicionais.
    	Exportar inicia um download da API para um arquivo chamado apis-export.apk. Este arquivo pode então ser importado para um ambiente ou organização diferente (consulte Exportando e importando APIs).
    	Excluir exclui permanentemente a API. Ao clicar em Excluir, uma caixa de diálogo de confirmação é exibida para confirmar que você deseja excluir permanentemente a API. Cuidado Documentação OpenAPI exibida no Portal a página não é atualizada automaticamente quando você exclui uma API. Para atualizar a documentação do OpenAPI, faça isso por meio do Portal Manager página.

  • Copiar URL: Copia a URL da API para sua área de transferência.

Visualização de lista

Para acessar a visualização de lista, selecione o Ícone de Visualização de lista.

A visualização de lista exibe APIs em uma tabela, com cada coluna descrita abaixo. Clicar em uma linha de API abre a gaveta de detalhes da API (descrito abaixo).

As colunas disponíveis são os seguintes:

• Nome da API: O nome da API.

• Versão A versão da API, conforme inserida durante a configuração da API.

• Tipo: O tipo de API, um dos seguintes:** API customizada, **Serviço OData ou proxy de API.

• Ambiente: O ambiente onde a API é armazenada.

• Status: O status da API, um dos Publicado, Publicado com rascunho, ou Rascunho.

• Última edição: A última data salva (em MM/DD/YYYY formato), hora (em HH:MM:SS formato) e o período de tempo (AM ou PM) no horário local do navegador.

• Raiz do serviço: Nome público da API, conforme inserido durante a configuração da API.

• Grupo: O nome de qualquer grupo de API a API pertence.

• Editado por: O nome do usuário que salvou a API pela última vez.

• Última publicação: A data da publicação (em MM/DD/YYYY formato), hora (em HH:MM:SS formato) e o período de tempo (AM ou PM) no horário local do navegador.

• Publicado por: O nome do usuário que publicou a API pela última vez.

• Gateway: O gateway da API usado pela API.

• Serviços: O número de serviços configurados para a API.

• Ações: Passe o mouse sobre a linha da API para revelar ações adicionais:

  • Detalhes: Abre a gaveta de detalhes da API (descrito na próxima seção).

  • Copiar URL base da API: Clique para copiar a URL base da API para sua área de transferência.

  • Exportar: Abre o seletor de pastas para sua máquina local. Selecione uma pasta para salvar a exportação da API. Para obter mais informações, consulte Exportar e importar APIs.

  • Editar: Abre a página Resumo e Confirmação da API, onde você pode editar as configurações da API.

  • Mais ações: Abre um menu com estas ações:

    Item de menu da API	Descrição
    Clone	Abre a tela de configuração da API (consulte Configuração de API customizada, Configuração do serviço OData, ou Configuração da proxy de API), pré-preenchido com os detalhes de configuração da API clonada e padrões atualizados para estes campos: Nome da API: O nome da API é prefixado com Cópia de. Raiz do serviço: A raiz do serviço é prefixada com Cópia de. Versão: A versão é anexada com -2. Este número não é incrementado com clones adicionais.
    Excluir	Exclui permanentemente a API. Ao clicar em Excluir, uma caixa de diálogo de confirmação é exibida para confirmar que você deseja excluir permanentemente a API. Cuidado Documentação OpenAPI exibida no Portal a página não é atualizada automaticamente quando você exclui uma API. Para atualizar a documentação do OpenAPI, faça isso por meio do Portal Manager página.
    Exibir no portal	(Habilitado somente para APIs personalizadas ou proxy com status Publicado ou Publicado com rascunho.) Abre o Portal página para a API.
    Exibir logs	Abre os Logs da API, que exibe logs de processamento e depurar (se o log de depurar estiver habilitado) para todas as APIs.
    Analytics	Abre o Analytics, que exibe métricas de consumo e desempenho para todas as APIs.

Gaveta de detalhes da API

Para ver os detalhes de uma API, selecione uma API na tabela enquanto estiver em visualização de lista. Uma gaveta é aberta na parte inferior da janela com cinco guias: Perfil, Configurações, Serviços, Perfis de segurança, Funções do usuário (para APIs personalizadas e serviços OData) e Cabeçalhos de solicitação (para APIs de proxy).

O cabeçalho da gaveta exibe estes detalhes e controles:

• Nome e versão da API: Exibe o nome da API e sua versão (se aplicável).
• Anterior / Próximo: Navega pela lista de APIs da organização.
• Expandir: Expande a gaveta para tela cheia. Uma vez expandida, clique no Ícone Minimizar para retornar à visualização anterior.
• Fechar: Fecha a gaveta.

Aba Perfil

A aba Perfil exibe informações gerais sobre a API:

• Tipo de API: O tipo de API, um dos seguintes:** API customizada, **Serviço OData ou proxy de API.

• URL base da API: URL base da API.

• Descrição: (Visível apenas para APIs personalizadas e serviços OData .) A descrição da API, conforme inserida durante a configuração da API.

• URL da API existente: (Visível apenas para APIs de proxy.) A URL da API para proxy.

Aba de configurações

A aba Configurações fornece uma visão geral das configurações da API (especificadas durante a configuração da API):

• Timeout: O número de segundos antes que a API expire. O padrão é 30 segundos. O máximo é 180 segundos.

  Nota

  Esta configuração é independente da configuração de tempo limite de operação no Integration Studio ou Design Studio. As configurações de tempo limite de operação não são usadas, a menos que um agente privado é usado e o EnableAPITimeout configuração no arquivo de configuração do agente privado está habilitado.

• Somente SSL: Quando habilitado (padrão), os dados são criptografados por meio de SSL e HTTPS é aplicado para todas as solicitações e respostas de API (recomendado).

  Quando desabilitado, os dados passados por solicitações e respostas de API não são criptografados e podem ser interceptados e visualizados por outros. Isso pode expor informações confidenciais.

• CORS: Quando habilitado, o Compartilhamento de Recursos de Origem Cruzada (CORS) mecanismo é usado (não recomendado).

  Aviso

  CORS causa operações usando o OPTIONS método para executar sem autenticação.

• Habilitar registro detalhado: Quando habilitado, o registro detalhado para APIs inclui dados de solicitação e resposta em cada registro de API para ajudar a monitorar dados de entrada e saída e facilitar a depuração. Esta configuração é desabilitada por padrão, pois pode criar grandes arquivos de log.

• Ativar modo de depuração até: Exibe a data e a hora em que o modo de depurar será desativado.

Aba Serviços

A aba Serviços tem uma tabela com uma visão geral dos serviços da API:

A tabela pode ser classificada por Nome do serviço, Método, Caminho, Projeto, Operação a ser acionada ou Tipo de resposta clicando na respectiva linha de cabeçalho.

• Nome do serviço: O nome do serviço da API.

• Método: O método de solicitação para o serviço de API, um dos seguintes: GET, POST, PUT, DELETE, ALL ou (se o Método estiver definido como CUSTOM) o nome do método personalizado.

• Caminho: O caminho para a solicitação.

• Projeto: (Visível somente para APIs personalizadas e serviços OData .) O nome do projeto do Integration Studio.

• Operação a ser acionada: (Visível somente para APIs personalizadas e serviços OData .) O nome da operação que está sendo chamada.

• Tipo de resposta: (Visível somente para APIs personalizadas e serviços OData .) O tipo de resposta, um dos seguintes: Destino final, Variável do sistema ou Sem resposta.

• Ações: Passe o mouse sobre a linha de serviço para revelar ações adicionais:

  • Copiar URL do serviço da API: Copia a URL do serviço da API para sua área de transferência.

  • Ir para o serviço de API: Abre a página Resumo e confirmação da API, onde você pode editar as configurações da API.

Aba Perfis de segurança

A aba Perfis de segurança fornece uma lista de todos os perfis de segurança usado para restringir o acesso para consumo da API:

A tabela pode ser classificada por Nome do perfil, Tipo ou Nome de usuário clicando na respectiva linha de cabeçalho.

• Nome do perfil: O nome do perfil de segurança.

• Tipo: O tipo de autenticação, um dos seguintes: Anônimo, Chave de API, Básico ou OAuth 2.0.

• Nome de usuário: Exibe o nome de usuário para quaisquer perfis de segurança usando autenticação Básica. Caso contrário, o tipo de autenticação é exibido.

• Ações: Passe o mouse sobre a linha do perfil de segurança para revelar uma ação adicional:

  • Ir para o perfil de segurança: Abre a tela de configuração para o perfil de segurança.

Aba de funções do usuário

A aba Funções do usuário fornece uma lista das funções da organização cujos membros têm acesso à API:

A tabela pode ser classificada por Função do Usuário clicando na respectiva linha de cabeçalho.

• Função do usuário: O nome da papel do usuário Harmony.

• Ações: Passe o mouse sobre a linha de papel do usuário para revelar uma ação adicional:

  • Ir para a papel do usuário: Abre o Gerenciamento de usuários do Console de gerenciamento página.

Aba de cabeçalhos de solicitação

A aba Cabeçalhos de solicitação fornece uma lista de cabeçalhos de solicitação da API do proxy:

A tabela pode ser classificada por Chave ou Valor clicando na respectiva linha de cabeçalho.

• Chave: A chave do cabeçalho da solicitação.

• Valor: O valor do cabeçalho da solicitação.

• Substituir entrada: Quando habilitado, o cabeçalho da solicitação substitui outros cabeçalhos de solicitação que usam a mesma chave.

  Nota

  Para editar esta configuração, você deve clicar em Editar na coluna Ação da API na tabela.

Configurações da página de visualização de lista

Você pode classificar a tabela, reorganizar suas colunas ou atualizar seu conteúdo:

• Classificar: Para classificar a tabela em ordem crescente, clique em qualquer título de coluna. Clique novamente para inverter a ordem de classificação.

• Colunas: Para alterar a disposição e a visibilidade das colunas, clique em Filtrar colunas. A gaveta Colunas abre:

  

  A gaveta tem os seguintes controles:

  • Pesquisar: Insira qualquer parte do nome da coluna na caixa de pesquisa para filtrar a lista de colunas (somente caracteres alfanuméricos). A pesquisa não diferencia maiúsculas de minúsculas.

  • Mostrar tudo: Torna todas as colunas visíveis.

  • Mover: Arraste e solte para alterar a posição da coluna em relação às outras.

  • Ocultar: A coluna está visível. Clique para ocultá-la.

  • Mostrar: A coluna está oculta. Clique para mostrá-la.

  • Salvar: Salva as colunas.

  • Cancelar: Fecha a gaveta de colunas sem salvar as alterações.