Publicar uma operação como uma API

Introdução

Esta página descreve como configurar e publicar uma API personalizada (para expor uma operação ao consumo) de dentro Integration Studio. A opção Publicar como uma API pode ser acessada no menu de ação da operação.

Alternativamente, APIs personalizadas podem ser criadas no API Manager Minhas APIs página.

APIs personalizadas (publicadas e rascunhos) são exibidas nestes locais:

• As Minhas APIs página do API Manager.
• A aba Recursos do painel do projeto para o Integration Studio projeto associado à API personalizada.

Pré-requisitos

Para usar a opção Publicar como uma API no menu de ação da operação, estes pré-requisitos devem ser atendidos:

• A organização acessada deve ter uma assinatura do API Manager e ter as permissões de papel apropriadas e níveis de acesso ao ambiente. Para obter informações sobre como adicionar o API Manager à sua licença, entre em contato com seu Gerente de sucesso do cliente (CSM).

• A operação não deve ter nenhuma alteração não implantada.

Configurar a API

Após clicar na opção Publicar como uma API no menu de ações da operação, uma caixa de diálogo de configuração de API personalizada é aberta com estas configurações:

• Nome da API: Insira um nome para a API usar para fins de identificação interna. Por padrão, este campo é preenchido com o nome da operação.

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

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

• Descrição: Insira uma descrição opcional para a API.

• Configurações adicionais: Clique para expandir as configurações adicionais:

  • Ambiente: Este campo é definido para o ambiente do projeto que está sendo acessado no momento e não pode ser alterado.

  • Número da versão: Insira uma versão opcional para usar como parte do URL do serviço da API. Este campo permite um máximo de 50 caracteres e não permite espaços ou certos caracteres especiais. Usar caracteres especiais diferentes de um ponto (.) ou um hífen (-) não é recomendado. Convenções de nomenclatura comuns incluem versões incrementais, como v1.0, v1.1, v1.2, ou usando uma data em que a API foi publicada, como 2023-09-21.

  • Timeout: Insira 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 Tempo limite da operação disponível na aba Opções da operação. As configurações de tempo limite de operação não são usadas para APIs do API Manager, a menos que um agente privado seja usado e o EnableAPITimeout configuração no arquivo de configuração do agente privado está habilitado.

  • Habilitar modo de depurar até: Selecione para habilitar o modo de depurar e habilite a inserção de uma data e hora correspondentes nas quais o modo de depurar será desabilitado. O período máximo de habilitação é de duas semanas. O modo de depuração habilita o rastreamento completo para cada solicitação recebida por meio da URL de serviço da API. Quando habilitado, o sistema retém o conteúdo completo de cada solicitação e resposta da API por até 24 horas a partir do momento em que a chamada da API foi recebida e se aplica a todas as operações acionadas pela API.

  • Somente SSL: Esta opção é selecionada por padrão e requer o uso de criptografia SSL (recomendado).

  • Habilitar CORS: Selecione para habilitar Compartilhamento de Recursos de Origem Cruzada (CORS) (não recomendado).

  • Habilitar registro detalhado: Selecione para habilitar o registro detalhado. Os registros detalhados para APIs incluem 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. Como isso pode criar grandes arquivos de log, o log verbose é desabilitado por padrão.

• Nome do serviço: Insira um nome para o serviço da API. Por padrão, este campo é definido como o nome da operação.

• Projeto: O nome do projeto que está sendo acessado no momento.

• Operação: O nome da operação que está sendo exposta para consumo.

• Método: Selecione um dos métodos de solicitação a ser usado para a operação selecionada: ALL, CUSTOM, DELETE, GET, POST ou PUT. Selecionar ALL criará um método de solicitação separado. DELETE, GET, POST, e PUT métodos de solicitação para a operação (o CUSTOM método não está incluso).

  Nota

  Serviços de API usando um CUSTOM método não terá documentação OpenAPI gerada através do Portal Manager devido a uma limitação da especificação OpenAPI.

• Tipo de resposta: Selecione entre Meta final, Variável do sistema ou Sem resposta:

  • Alvo final: A resposta da API é o alvo final da operação. Quando esse tipo de resposta é selecionado, a operação deve ter (como o alvo final da cadeia de operação ) an Integration Studio Atividade de resposta da API. Se qualquer outro destino final for usado, a resposta da API estará vazia.

  • Variável do sistema: A resposta da API é definida em uma variável Jitterbit na operação. Quando esse tipo de resposta é selecionado, a operação deve ter (como parte de uma cadeia de operação ) um script que define a variável Jitterbit jitterbit.api.response igual à resposta que você quer que a API retorne. Se essa variável não for definida, a resposta da API estará vazia.

  • Sem resposta: A resposta da API está em branco. Se a solicitação para executar a operação selecionada for aceita, a API retornará uma resposta vazia imediata com o código HTTP 202.

• Funções do usuário: Selecione as funções da organização cujos membros terão acesso à API nas páginas do API Manager listadas abaixo. As funções para escolher são aquelas definidas na página Gerenciamento de usuários do Management Console.

  Isso determina o acesso a esta API específica a partir destas páginas:

  • Minhas APIs
  • Gerenciador do Portal, incluindo geração de documentação de API
  • Portal
  • Registros da API
  • Análise

  Acesso aos Perfis de Segurança página e o acesso para consumir a API não são afetados por esta seleção. (O acesso para consumir uma API é controlado por perfis de segurança.)

  Quaisquer funções de usuário definidas com a permissão Admin sempre têm acesso total a todas as APIs e, portanto, não podem ser desmarcadas da seleção. (Na captura de tela de exemplo mostrada acima, a papel Administrator não pode ser desmarcada por esse motivo.)

• Perfil: Opcionalmente, use o menu para selecionar um perfil de segurança existente para restringir o acesso para consumo da API.

  Nota

  Se não houver perfis de segurança existentes configurados para o ambiente acessado no momento, você pode configurar um no API Manager. Para obter instruções, consulte Configuração do perfil de segurança.

• Publicar: Salva a API no status Publicado. A API fica ativa e acessível em cinco minutos. Uma API publicada conta como uma API URL em relação à sua franquia de assinatura Harmony. Você pode acessar a API publicada no API Manager Minhas APIs página.

• Salvar rascunho: Salva a API no status Rascunho e pode ser acessada no API Manager Minhas APIs página. Um rascunho de API não conta como uma API URL em relação à sua franquia de assinatura Harmony. Você pode acessar e concluir a configuração do rascunho de API no API Manager My APIs página.

• Cancelar: Fecha o diálogo sem salvar.