Página de APIs no Jitterbit API Manager

Introdução

A página de APIs é a página principal do API Manager. Ela permite que os administradores da organização Harmony gerenciem três tipos de APIs:

• APIs Personalizadas
• APIs OData
• APIs Proxy

É possível criar APIs utilizando o Assistente de IA do APIM com comandos em linguagem natural ou manualmente usando as telas de configuração.

Membros de um papel que recebeu acesso Somente Leitura ao ambiente podem visualizar apenas as APIs nesse ambiente. Membros de um papel que recebeu acesso Gravação ao ambiente têm acesso de gravação nesse ambiente.

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

Cabeçalho da página de APIs

O cabeçalho na parte superior da página de APIs inclui os seguintes controles:

• URL base da API: A URL base da API da organização Harmony. Clique no ícone Copiar para copiar a URL para sua área de transferência. (Uma confirmação da ação aparece.)

• URLs de API Personalizadas usadas: O número de URLs de API personalizadas atualmente utilizadas em relação ao número total de URLs de API personalizadas permitidas pela assinatura da organização. As URLs de API atualmente utilizadas incluem aquelas usadas por APIs personalizadas publicadas e APIs OData e seus clones publicados. APIs em rascunho não contam como URLs de API em uso.

• URLs da API Proxy usadas: O número de URLs da API Proxy atualmente utilizadas em relação ao número total de URLs da API Proxy permitidas pela assinatura da organização. As URLs da API Proxy atualmente usadas incluem aquelas utilizadas por APIs Proxy publicadas e suas clones publicadas. APIs em 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, Papel do Usuário, Ú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. Quando o painel está fechado e os filtros estão ativos, um distintivo numérico no ícone 7 Filtro mostra o número total de filtros aplicados.

• Pesquisar: Digite 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. Use apenas caracteres alfanuméricos. A pesquisa não diferencia maiúsculas de minúsculas.

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

• Baixar tudo: Baixa os detalhes de todas as APIs selecionadas como um arquivo CSV. Esta opção está disponível quando uma ou mais APIs estão selecionadas. Clique para abrir a caixa de diálogo Baixar detalhes da API, onde você pode selecionar campos adicionais para incluir e usar para reordená-los. Alguns campos são pré-selecionados e não podem ser removidos. Clique em Baixar para salvar o arquivo.

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

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

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

  • Criar com IA: Abre o Assistente APIM para criar uma API usando prompts em linguagem natural. Para mais informações, veja Usando o Assistente de IA.

    Nota

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

  As seguintes opções aparecem apenas se uma URL de API correspondente estiver disponível:

  • API Personalizada: Abre a tela de configuração da API personalizada para criar manualmente uma nova API personalizada.

  • API Proxy: Abre a tela de configuração da API proxy para criar manualmente uma nova API proxy.

  • API OData: Abre a tela de configuração da API OData para criar manualmente uma nova API OData.

Visualização em lista

Para acessar a visualização em lista, selecione o ícone Visualização em lista.

A visualização em lista exibe APIs em uma tabela. Cada coluna é descrita abaixo. Clique em uma linha de API para abrir o painel de detalhes da API.

As colunas disponíveis são as 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, uma das API Personalizada, API OData ou API Proxy.

• Ambiente: O ambiente onde a API está armazenada.

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

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

• Raiz do Serviço: O nome público da API, conforme inserido durante a configuração da API.

• Grupo: O nome de quaisquer grupos de API aos quais a API pertence.

• Editado Por: O nome do usuário que salvou a API por último.

• Última Publicação: A data de publicação (no formato DD/MM/AAAA), hora (no formato HH:MM:SS), 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 por último.

• Gateway: O gateway da API utilizado 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 (descrita na próxima seção).

  • Copiar URL base da API: Clique para copiar a URL base da API para sua área de transferência. Uma mensagem de confirmação aparece quando a ação é concluída.

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

  • Baixar: Baixa os detalhes da API como um arquivo CSV. Clique para abrir a caixa de diálogo Baixar detalhes da API, onde você pode selecionar campos adicionais para incluir e usar para reordená-los. Alguns campos são pré-selecionados e não podem ser removidos. Clique em Baixar para salvar o arquivo.

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

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

    Item do menu da API	Descrição
    Clonar	Abre a tela de configuração da API (veja Configuração de API personalizada, Configuração de API OData ou Configuração de API Proxy), pré-preenchida com os detalhes de configuração da API clonada e padrões atualizados para estes campos: Nome da API: O nome da API é precedido por Cópia de. Raiz do Serviço: A raiz do serviço é precedida por Cópia de. Versão: A versão é acrescida de -2. Este número não aumenta 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 A documentação OpenAPI exibida na página do Portal da API não é atualizada automaticamente quando você exclui uma API. Para atualizar a documentação OpenAPI, use a página do Gerenciador do Portal ou a aba Documentação na página das APIs.
    Ver no portal	(Habilitado apenas para APIs personalizadas ou proxy com status Publicado ou Publicado com Rascunho.) Abre a página do Portal da API para a API.
    Ver logs	Abre a página de Logs da API, que exibe logs de processamento e depuração (se o registro de depuração estiver habilitado) para todas as APIs.
    Análise	Abre a página de Análise, que exibe métricas de consumo e desempenho para todas as APIs.

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

É possível classificar a tabela, reorganizar suas colunas ou atualizar seu conteúdo:

• Classificar: Para classificar a tabela em ordem crescente, clique em qualquer cabeçalho 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. O painel Colunas se abre:

  

  O painel possui os seguintes controles:

  • Pesquisar: Digite qualquer parte do nome da coluna na caixa de pesquisa para filtrar a lista de colunas. Use apenas 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: Salvar as colunas.

  • Cancelar: Fechar o painel sem salvar as alterações.

Visualização em cartão

Para acessar a visualização em cartão, selecione o ícone Visualização em cartão.

A visualização em cartão exibe APIs como cartões em uma grade.

Cada cartão exibe as seguintes informações:

• Nome da API: O nome da API. Passe o mouse sobre o cartão e clique no ícone Copiar ao lado do nome para copiar a URL do serviço da API para a área de transferência. O ícone indica o tipo da API:

  Ícone	Tipo de API
  	API Customizada
  	API OData
  	API Proxy

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

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

• Ambiente: O nome e a classe do ambiente onde a API está armazenada.

• Ícone de status: Um ícone colorido à esquerda do email do último usuário editado indica o status atual da API:

  Cor	Status
  	A API está publicada.
  	A API está publicada com um rascunho.
  	A API é um rascunho.

• Última edição por: O endereço de email do usuário que editou a API por último.

• Data da última edição: A data (no formato MM/DD/YY) e hora (no formato HH:MM AM/PM) em que a API foi editada pela última vez, no horário local do navegador.

Clique em um cartão para abrir o painel de detalhes da API. Clique no ícone do menu de ações no canto superior direito de um cartão para abrir um menu com estas ações:

API details drawer

Você pode abrir o painel de detalhes da API a partir da visualização de lista, selecionando uma API na tabela ou clicando em Editar, ou a partir da visualização de cartão clicando em um cartão. Um painel se abre na parte inferior da janela com estas abas dependendo do tipo de API:

O cabeçalho do painel 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 o painel para tela cheia. Uma vez expandido, clique no ícone Minimizar para retornar à visualização anterior.

• Fechar: Fecha o painel.

• Descartar alterações: Após fazer alterações, clique para fechar o painel sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

• Salvar como rascunho: Salva quaisquer alterações na API no status Rascunho ou Publicado com Rascunho:

  • Rascunho: Uma nova API ou uma API cujo status era Rascunho quando Salvar como Rascunho foi utilizado. Rascunhos não contam contra o limite da sua assinatura.

• Publicado com Rascunho: Uma API cujo status era Publicado quando Salvar como Rascunho foi utilizado. Uma API que é publicada com um rascunho conta contra o seu limite de assinatura porque a API é acessível, mesmo que seu rascunho não esteja.

• Publicar: Salva as alterações na API com status Publicado. A API está ao vivo e acessível em cinco minutos. Uma API publicada conta contra o seu limite de assinatura porque a API é acessível. Um diálogo indica que a API está ao vivo. Clique em Copiar URL para copiar a URL do serviço da API.

Aba de Perfil

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

• Tipo de API: O tipo de API, uma das opções API Personalizada, API OData ou API Proxy.

• URL Base da API: A URL base da API.

• Nome da API: O nome da API para fins de identificação interna. Os seguintes caracteres especiais são permitidos: ( ) - _

• Raiz do Serviço: O nome público da API a ser usado como parte da URL do serviço da API. Por padrão, este campo é preenchido com o nome da API convertido para camel case. Este campo não permite espaços ou certos caracteres especiais. O uso de caracteres especiais além de um sublinhado (_) não é recomendado. Os seguintes caracteres especiais são permitidos:

  . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

• Descrição: (Visível apenas para APIs personalizadas e APIs OData.) A descrição da API.

• Ambiente: O ambiente onde a API reside. Este campo não pode ser editado.

• Número da Versão: O número da versão usado como parte da URL do serviço da API. Este campo permite um máximo de 48 caracteres e não permite espaços ou certos caracteres especiais. O uso de caracteres especiais além de um ponto (.) ou um hífen (-) não é recomendado. Convenções comuns de nomenclatura incluem versões incrementais, como v1.0, v1.1, v1.2, ou o uso de uma data quando a API foi publicada, como 2025-08-28.

Aba de Configurações

Na aba Configurações, você pode visualizar ou editar as configurações de uma API:

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

  Nota

  Esta configuração é independente da configuração de tempo limite de operação em Studio ou Design Studio. As configurações de tempo limite de operação não são utilizadas a menos que um agente privado seja usado e a configuração EnableAPITimeout no arquivo de configuração do agente privado esteja habilitada.

• Apenas SSL: Quando habilitado (padrão), os dados são criptografados através de SSL e HTTPS é imposto para todas as solicitações e respostas da API (recomendado).

  Quando desabilitado, os dados transmitidos através das solicitações e respostas da API não são criptografados e podem ser interceptados e visualizados por outros. Isso pode potencialmente expor informações sensíveis.

• CORS: Quando habilitado, o mecanismo de Cross-Origin Resource Sharing (CORS) é utilizado (não recomendado).

  Aviso

  O CORS faz com que operações usando o método OPTIONS sejam executadas sem autenticação.

• 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 está desabilitada por padrão, pois pode criar arquivos de log grandes.

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

Aba de API Existente

Na aba API Existente, você pode visualizar e editar a URL base de uma API proxy:

• URL Base da API: A URL base da API a ser proxy.

  Nota

  Se a API fornecer um único serviço, você pode inserir a URL completa da API, incluindo o caminho do serviço.

• Fornecer documento OpenAPI: Quando um documento OpenAPI é fornecido, ele é usado para descobrir automaticamente os serviços da API. Selecione Não para pular ou Sim para expandir uma área adicional para fornecer o documento OpenAPI:

  

  • URL OpenAPI: Quando selecionado, um campo URL OpenAPI fica disponível para você inserir uma URL. Clique em Aplicar para carregar um documento OpenAPI no formato YAML ou JSON a partir da URL.

  • Enviar arquivo: Quando selecionado, envia um documento OpenAPI no formato YAML ou JSON após usar Procurar para selecionar o arquivo:

    

  • Editor de documentos: Permite visualizar e editar um documento OpenAPI fornecido. Você também pode fornecer um documento OpenAPI inserindo-o diretamente aqui. Para visualizar e editar o documento OpenAPI em uma área maior, clique no ícone de expansão (após abrir essa área, clique no ícone de retorno para voltar a esta tela).

Aba Serviços

Na aba Serviços, você pode adicionar novos serviços ou visualizar e editar os serviços atuais da API. Clique em um serviço da API para editá-lo.

Você pode classificar a tabela por Nome do Serviço, Método, Caminho, Projeto, Operação a Acionar ou Tipo de Resposta clicando na respectiva linha de cabeçalho.

• Pesquisar: Insira qualquer parte do nome do serviço, método, caminho, projeto, operação ou tipo de resposta na caixa de pesquisa para filtrar a lista de serviços. Use apenas caracteres alfanuméricos. A pesquisa não diferencia maiúsculas de minúsculas.

• Novo Serviço: Adiciona uma linha de serviço da API ao final da tabela. Insira ou selecione valores para cada campo na tabela (descrito abaixo).

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

• Método: O método de solicitação para o serviço da API, um dos 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 apenas para APIs personalizadas e APIs OData.) O nome do projeto do Studio.

• Operação a Ser Acionada: (Visível apenas para APIs personalizadas e APIs OData.) O nome da operação que está sendo chamada.

• Tipo de Resposta: (Visível apenas para APIs personalizadas e APIs OData.) O tipo de resposta, um dos Final Target, System Variable, ou No Response.

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

  • Copiar URL do serviço da API: Clique para copiar o URL do serviço da API para sua área de transferência. (Uma confirmação da ação aparece.)

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

  • Duplicar: (Visível apenas para APIs personalizadas e APIs OData.) Cria uma duplicata do serviço da API. Você deve alterar o método de solicitação ou o Caminho, pois cada serviço da API deve ter uma combinação única desses campos.

  • Excluir: Exclui o serviço da API.

  Quando você clica em uma linha de serviço de API personalizada, essas abas aparecem:

  

  Aba de parâmetros de caminho

  Quando parâmetros de solicitação estão incluídos no Caminho, esta aba é preenchida com esses campos:

  

  • Parâmetro: Exibe os parâmetros de solicitação definidos no Caminho.

  • Descrição: Opcionalmente, insira uma descrição para os parâmetros de solicitação.

  Aba de parâmetros de consulta

  Esta aba permite que você adicione parâmetros de consulta ao serviço da API:

  

• Adicionar Parâmetro: Clique para adicionar um parâmetro de consulta ao serviço da API. Quando clicado, esses campos ficam disponíveis:

  • Parâmetro: Insira o nome do parâmetro de consulta.

  • Descrição: Opcionalmente, insira a descrição do parâmetro de consulta.

  • Excluir: Clique no ícone de excluir ao lado de um parâmetro de consulta para deletar esse parâmetro.

Aba de Cabeçalhos

Esta aba permite que você adicione cabeçalhos de solicitação ao serviço da API:

• Adicionar Parâmetro: Clique para adicionar um cabeçalho de solicitação ao serviço da API. Quando clicado, esses campos ficam disponíveis:

  • Parâmetro: Insira o nome do cabeçalho de solicitação.

  • Descrição: Opcionalmente, insira a descrição do cabeçalho de solicitação.

  • Obrigatório: Selecione se o cabeçalho de solicitação deve ser obrigatório para cada solicitação do serviço da API.

  • Excluir: Exclui o cabeçalho de solicitação.

Aba de Perfis de Segurança

A aba Perfis de Segurança fornece uma lista de perfis de segurança disponíveis no ambiente:

Você pode classificar a tabela por Nome do Perfil, Tipo ou Nome de Usuário clicando na respectiva linha do cabeçalho.

• Pesquisar: Insira qualquer parte do nome do perfil de segurança, tipo ou nome de usuário na caixa de pesquisa para filtrar a lista de serviços. Use apenas caracteres alfanuméricos. A pesquisa não diferencia maiúsculas de minúsculas.

• Atribuir: Use o botão para atribuir ou desatribuir o perfil de segurança à API.

  Regras de atribuição de perfil de segurança

  • Múltiplos perfis: Você pode atribuir múltiplos perfis de segurança com o mesmo tipo de autenticação a uma API. Apenas os tipos de autenticação basic e API key podem ser usados juntos.

  • Publicação de alterações: Quando você desatribui um perfil de segurança de uma API usando o botão, a alteração é salva como um rascunho. Você deve publicar a API (usando Publicar no cabeçalho do painel) para que a alteração tenha efeito. Até que a API seja publicada, o perfil de segurança ainda é considerado "em uso" e não pode ser excluído da página Perfis de Segurança.

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

• Tipo: O tipo de autenticação, um dos 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 que utilizam 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 papéis de usuário

A aba Papéis de usuário fornece uma lista dos papéis da organização cujos membros têm acesso à API:

Você pode classificar a tabela por Papel de Usuário clicando na respectiva linha do cabeçalho.

• Pesquisar: Digite qualquer parte do papel de usuário, permissão ou status na caixa de pesquisa para filtrar a lista de serviços. Use apenas caracteres alfanuméricos. A pesquisa não diferencia maiúsculas de minúsculas.

• Novo papel de usuário: Abre um painel para configurar um novo papel de usuário:

  

  • Nome do papel: Digite um nome exclusivo para o papel.
  • Permissões: Clique para abrir o menu e, em seguida, selecione pelo menos uma permissão da lista.

  • Status: Exibe se o papel de usuário está atribuído ou não atribuído à API.

    Regras de gerenciamento de papéis

    Essas regras se aplicam ao gerenciamento de papéis em APIs:

    • Usuários com Admin permissão ou Acesso de gravação acesso ao ambiente podem atribuir ou desatribuir papéis às APIs.
    • Usuários com Admin permissão podem criar e atribuir novos papéis.
    • Usuários com Admin permissão não podem ser desatribuídos de nenhuma API por nenhum usuário.

  • Salvar: Salva a função e a adiciona à tabela de funções.

  • Cancelar: Fecha o painel sem salvar as alterações.

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

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

  • Ir para a função do usuário: Abre a página de Gerenciamento de Usuários da Console de Gerenciamento.

Aba de cabeçalhos de solicitação

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

Você pode classificar a tabela por Chave ou Valor clicando na respectiva linha do cabeçalho.

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

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

• Substituir Entrada: Quando ativado, o cabeçalho de 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.

• Ações: Passe o mouse sobre a linha do cabeçalho de solicitação para revelar uma ação adicional:

  • Excluir cabeçalho: Exclui a linha do cabeçalho de solicitação.

Aba de Documentação

A aba Documentação está disponível ao editar uma API publicada e permite que você visualize, edite e publique a documentação OpenAPI para essa API individual. Esta aba está disponível para APIs personalizadas, proxy e OData publicadas.

• Regenerar Docs: Clique para regenerar e sobrescrever a documentação OpenAPI apenas para esta API. Esta opção está disponível apenas para APIs que já estão publicadas.

  Aviso

  Usar esta opção sobrescreve a documentação existente para esta API, incluindo quaisquer personalizações. Faça backup da documentação existente copiando-a para um editor de texto externo antes de usar esta opção. Após regenerar a documentação, reaplique manualmente quaisquer personalizações colando-as no editor conforme apropriado.

• Salvar e Publicar: Clique para salvar e publicar as alterações na documentação apenas para esta API na página do Portal da API.

• Editor: Edite o conteúdo da documentação YAML para esta API diretamente no editor. As alterações são refletidas na pré-visualização do Swagger no lado direito da aba.

  Após fazer as edições, clique em Salvar e Publicar para publicar a documentação atualizada na página do Portal da API.

• Pré-visualização do Swagger: Exibe a documentação interativa do Swagger UI para a API. Você pode usar a pré-visualização para testar a API diretamente na aba Documentação usando os mesmos controles descritos em Testar APIs na página do Portal Manager.