Página de APIs no Jitterbit API Manager

Introdução

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

• APIs personalizadas
• Serviços OData
• APIs proxy

Você pode criar APIs usando o Assistente de IA do APIM com prompts em linguagem natural ou manualmente usando as telas de configuração.

Membros de uma função que recebeu acesso de Leitura ao ambiente podem visualizar apenas as APIs nesse ambiente. Membros de uma função que recebeu acesso de Escrita ao ambiente têm acesso de escrita nesse ambiente.

Para acessar a página 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 APIs inclui estes 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 em uso do total de URLs de API personalizadas permitidas pela assinatura da organização. As URLs de API atualmente em uso incluem aquelas usadas por APIs personalizadas e serviços OData publicados e seus clones publicados. APIs em rascunho não contam como URLs de API em uso.

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

• Pesquisa: Digite texto na caixa de pesquisa para filtrar instantaneamente as APIs exibidas na visualização de lista ou visualização de cartão, correspondendo o texto inserido ao conteúdo atualmente mostrado nas colunas da tabela ou nos cartões. A pesquisa não diferencia maiúsculas de minúsculas.

  Os controles ao lado da caixa de pesquisa permitem criar, salvar e reutilizar critérios mais avançados:

  • Salvar consulta: Abre o diálogo Criar novo filtro para salvar os critérios atualmente aplicados usando Filtros avançados ou Pesquisar com script como uma consulta nomeada que você pode reutilizar depois. O texto inserido diretamente na caixa de pesquisa não é incluído em uma consulta salva. O diálogo tem os seguintes campos:

    • Nome do filtro: Um nome obrigatório para a consulta salva. Um nome padrão (por exemplo, New Query_47102) é preenchido previamente.

    • Consulta: Os critérios de pesquisa atuais, preenchidos previamente usando a mesma sintaxe criterion=value; que Pesquisar com script. Edite diretamente se necessário.

    • Colunas: Selecione quais colunas exibir quando a consulta salva for aplicada. Selecione Todas as colunas para incluir todas as colunas ou selecione colunas individuais. Nome da API é sempre incluído e não pode ser desmarcado.

    Clique em Salvar e pesquisar para salvar a consulta e aplicá-la imediatamente ou Cancelar para fechar o diálogo sem salvar.

• Consultas salvas: Clique para visualizar suas consultas salvas. Selecione uma consulta salva para aplicá-la ou use os ícones Editar ou Excluir para gerenciá-la.

• Pesquisar com script: Insira seus critérios de pesquisa diretamente na caixa de pesquisa usando a sintaxe criterion=value; (por exemplo, apiName=Customers;). Combine vários critérios na mesma pesquisa separando-os com ponto e vírgula (;).

• Filtros avançados: Abre um painel para criar uma pesquisa usando estes critérios integrados:

  • Nome da API
  • Tipo
  • Status
  • Grupo
  • Ambiente
  • Raiz do serviço
  • Função do usuário
  • Gateway
  • Perfil de segurança
  • Última edição
  • Publicado por
  • Última publicação

  Para cada critério, exceto Última edição e Última publicação, clique no controle do operador = para escolher Igual a ou Não igual a, depois selecione ou insira um valor para corresponder. Para Última edição e Última publicação, clique no campo de data para escolher um intervalo de datas relativo ou absoluto.

  Clique em Pesquisar para aplicar os critérios ou em Redefinir para limpar o painel sem aplicá-lo. Alternar para Pesquisar com script converte os critérios atualmente aplicados no script equivalente.

  Os critérios aplicados usando Filtros avançados aparecem como rótulos ao lado da caixa de pesquisa (por exemplo, Nome da API (1)), com quaisquer critérios aplicados adicionais além do primeiro recolhidos em um rótulo Mais mostrando a contagem total. Clique no ícone em um rótulo para remover esse critério. Se aplicados usando Filtros avançados ou Pesquisar com script, clique em Limpar filtros para remover todos os critérios aplicados e retornar à lista padrão de APIs.

  Nota

  Filtros avançados não podem ser usados ao mesmo tempo que uma pesquisa de texto simples. Enquanto os critérios de Filtros avançados estão aplicados, o texto digitado diretamente na caixa de pesquisa não filtra a lista. Clique em Limpar filtros para retornar à pesquisa de texto simples.

  Se nenhuma API corresponder aos critérios de pesquisa aplicados, a visualização de tabela ou cartão exibe uma mensagem indicando que nenhum item correspondente foi encontrado.

• Visualização: Clique no ícone de 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 em formato APK (consulte Exportando e importando APIs).

• Exportar API: Abre a tela de exportação de API, onde você pode exportar APIs selecionadas em formato APK (consulte 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, consulte Usando 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 esta 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 de API personalizada para criar manualmente uma nova API personalizada.

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

• OData Service: Abre a tela de configuração do serviço OData para criar manualmente um novo serviço 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 as APIs em uma tabela. Cada coluna é descrita abaixo. Clique em uma linha de API para abrir a gaveta 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, um de Custom API, OData Service ou Proxy API.

• Ambiente: O ambiente onde a API é armazenada.

• Status: O status da API, um de Publicada, Publicada com rascunho ou Rascunho.

• Última edição: A data da última gravação (em formato MM/DD/YYYY), hora (em formato HH:MM:SS) e período do dia (AM ou PM) na hora 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 qualquer grupo de APIs ao qual a API pertence.

• Editado por: O nome do usuário que fez a última gravação da API.

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

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

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

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

  • Exportar: Abre o seletor de pasta do seu computador local. Selecione uma pasta para salvar a exportação da API. Para mais informações, consulte Exportar e importar APIs.

  • Download: Faz download dos detalhes da API como um arquivo CSV. Clique para abrir a caixa de diálogo Download de 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 Download para salvar o arquivo.

  • 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 do menu da API	Descrição
    Clonar	Abre a tela de configuração da API (consulte Configuração de Custom API, Configuração de serviço OData ou Configuração de Proxy API), 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ópiade. 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. Caution A documentação OpenAPI exibida na página API Portal não é atualizada automaticamente quando você exclui uma API. Para atualizar a documentação OpenAPI, use a página Portal Manager ou a guia Documentação na página APIs.
    Visualizar no portal	(Habilitado apenas para APIs personalizadas ou proxy com status Publicada ou Publicada com Rascunho.) Abre a página API Portal da API.
    Visualizar logs	Abre a página API Logs, que exibe logs de processamento e depuração (se o log de depuração estiver habilitado) para todas as APIs.
    Analytics	Abre a página Analytics, que exibe métricas de consumo e desempenho para todas as APIs.

Configurações da página de exibiçã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. A gaveta Colunas é aberta:

  

  A gaveta 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 exibi-la.

  • Salvar: Salva as colunas.

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

Exibição em cartão

Para acessar a exibição em cartão, selecione o ícone Exibição em cartão.

A exibição em cartão mostra as 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 de API:

  Ícone	Tipo de API
  	API customizada
  	Serviço OData
  	API de 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 do ambiente e a classe onde a API está armazenada.

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

  Cor	Status
  	A API foi publicada.
  	A API foi publicada com um rascunho.
  	A API é um rascunho.

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

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

Clique em um cartão para abrir a gaveta 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:

Gaveta de detalhes da API

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

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. Após expandir, clique no ícone Minimizar para retornar à visualização anterior.

• Fechar: Fecha a gaveta.

• Descartar alterações: Após fazer alterações, clique para fechar a gaveta sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

• Salvar como rascunho: Salva qualquer alteração na API com status Rascunho ou Publicado com Rascunho:

  • Rascunho: Uma API nova ou uma API cujo status era Rascunho quando Salvar como rascunho foi usado. Os rascunhos não contam contra seu limite de assinatura.

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

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

Aba Perfil

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

• Tipo de API: O tipo de API, um de API personalizada, Serviço 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 para usar 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. Não é recomendado usar caracteres especiais diferentes de um sublinhado (_). Os seguintes caracteres especiais são permitidos:

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

• Descrição: (Visível apenas para APIs personalizadas e serviços 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: A versão usada 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. Não é recomendado usar caracteres especiais diferentes de um ponto (.) ou um hífen (-). As convenções de nomenclatura comuns incluem versões incrementais, como v1.0, v1.1, v1.2, ou usar uma data quando a API foi publicada, como 2025-08-28.

Aba Configurações

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

• Tempo limite: O número de segundos antes da API expirar. O padrão é 30 segundos. O máximo é 180 segundos.

  Nota

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

• Apenas SSL: Quando ativado (padrão), os dados são criptografados via SSL e HTTPS é obrigatório para todas as solicitações e respostas de API (recomendado).

  Quando desativado, os dados transmitidos por meio de solicitações e respostas de API não são criptografados e podem ser interceptados e visualizados por terceiros. Isso pode expor informações sensíveis.

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

  Aviso

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

• Log detalhado: Quando ativado, o log detalhado para APIs inclui dados de solicitação e resposta em cada log de API para ajudar a monitorar dados de entrada e saída e facilitar a depuração. Esta configuração está desativada por padrão, pois pode criar arquivos de log grandes.

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

Aba API Existente

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

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

  Nota

  Se a API fornece 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 do OpenAPI: Quando selecionado, um campo URL do OpenAPI fica disponível para você inserir uma URL. Clique em Aplicar para carregar um documento OpenAPI em formato YAML ou JSON a partir da URL.

  • Fazer upload de arquivo: Quando selecionado, faz upload de um documento OpenAPI em formato YAML ou JSON após usar Procurar para selecionar o arquivo:

    

  • Editor de documento: Permite visualizar e editar um documento OpenAPI fornecido. Você também pode fornecer um documento OpenAPI inserindo-o aqui diretamente. 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 serviços de API atuais. Clique em um serviço de API para editá-lo.

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

• Pesquisar: Digite 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 de API ao final da tabela. Digite ou selecione valores para cada campo na tabela (descrito abaixo).

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

• Método: O método de requisição para o serviço de API, um de 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 requisição.

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

• Operação a Disparar: (Visível apenas para APIs personalizadas e serviços OData.) O nome da operação sendo chamada.

• Tipo de Resposta: (Visível apenas para APIs personalizadas e serviços OData.) O tipo de resposta, um de Final Target, Variável do Sistema, ou Sem Resposta.

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

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

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

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

  • Deletar: Deleta o serviço de API.

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

  

  Aba Parâmetros de Caminho

  Quando parâmetros de requisição são incluídos no Caminho, esta aba é preenchida com estes campos:

  

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

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

  Aba Parâmetros de Consulta

  Esta aba permite adicionar parâmetros de consulta ao serviço de API:

  

  • Adicionar Parâmetro: Clique para adicionar um parâmetro de consulta ao serviço de API. Quando clicado, estes 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.

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

  Aba Cabeçalhos

  Esta aba permite adicionar cabeçalhos de requisição ao serviço de API:

  

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

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

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

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

    • Deletar: Deleta o cabeçalho de requisição.

Aba Perfis de Segurança

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

Você pode ordenar a tabela por Nome do Perfil, Tipo, ou Nome de Usuário clicando na respectiva linha de 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 de alternância 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.

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

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

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

• Nome de Usuário: Exibe o nome de usuário para qualquer perfil de segurança que use 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 perfil de segurança: Abre a tela de configuração do perfil de segurança.

Aba Funções de Usuário

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

É possível classificar a tabela por Função de Usuário clicando na linha de cabeçalho respectiva.

• Pesquisa: Digite qualquer parte da função 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.

• Nova função de usuário: Abre um painel para configurar uma nova função de usuário:

  

  • Nome da função: Digite um nome único para a função.
  • Permissões: Clique para abrir o menu e selecione pelo menos uma permissão da lista.

  • Status: Exibe se a função de usuário está atribuída ou não atribuída à API.

    Regras de gerenciamento de funções

    Estas regras se aplicam ao gerenciar funções em APIs:

    • Usuários com permissão Admin ou acesso ao ambiente Gravação podem atribuir ou desatribuir funções a APIs.
    • Usuários com permissão Admin podem criar e atribuir novas funções.
    • Usuários com permissão Admin 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 de Usuário: O nome da função de usuário do Harmony.

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

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

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

É possível classificar a tabela por Chave ou Valor clicando na linha de cabeçalho respectiva.

• 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, é necessário 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 Documentação

A aba Documentação está disponível ao editar uma API publicada e permite visualizar, editar e publicar documentação OpenAPI para essa API individual. Esta aba está disponível para serviços personalizados, proxy e OData publicados.

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

  Aviso

  O uso desta opção sobrescreve a documentação existente para esta API, incluindo qualquer personalização. Faça backup da documentação existente copiando-a em um editor de texto externo antes de usar esta opção. Após regenerar a documentação, reaplique manualmente qualquer personalização colando-a no editor conforme apropriado.

Para regenerar a documentação sem sobrescrever personalizações, use Regenerar Docs na página Portal Manager. Ao regenerar a documentação de todas as APIs personalizadas e proxy em um ambiente de uma vez, essa opção preserva e reaplica automaticamente as personalizações, permitindo resolver conflitos. Essa alternativa não está disponível para serviços OData.

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

• Editor: Edite o conteúdo da documentação YAML para esta API diretamente no editor. As alterações são refletidas na 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 API Portal.

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

Solução de problemas

Para a solução de problemas relacionada, consulte o seguinte no guia de solução de problemas do API Manager:

• Não é possível publicar uma API: limite de API de assinatura atingido

• API publicada retorna 404 Not Found

• O ambiente da API não pode ser alterado após a criação

• Botão "Nova API" não visível apesar da função de organização correta

• URL do serviço excede o comprimento máximo (HTTP 414)

• Não é possível excluir uma API no API Manager