Acionador de API

Os acionadores de API são usados para invocar diretamente execuções para integrações.

A configuração de um acionador de API na sua integração permite-lhe fazer o seguinte:

• Defina o payload de pedido e resposta através de variáveis de entrada e saída específicas do acionador.
• Gere e veja a especificação OpenAPI (OAS) para a sua integração.
• Invocar uma integração síncrona ou assíncronamente.

Para ajudar a começar a usar os acionadores de API, consulte o tutorial de preenchimento de APIs. O tutorial mostra-lhe como criar uma integração com um acionador de API que recebe pedidos de API para obter informações dos clientes.

Adicione um acionador de API

Para adicionar um acionador de API à sua integração, siga estes passos:

1. Na Google Cloud consola, aceda à página Application Integration.

   Aceda à solução Application Integration

2. No menu de navegação, clique em Integrações

   A página Lista de integrações é apresentada com todas as integrações disponíveis no projeto do Google Cloud.

3. Selecione uma integração existente ou clique em Criar integração para criar uma nova.

   Se estiver a criar uma nova integração:

   1. Introduza um nome e uma descrição no painel Criar integração.
   2. Selecione uma região para a integração.
   3. Selecione uma conta de serviço para a integração. Pode alterar ou atualizar os detalhes da conta de serviço de uma integração em qualquer altura no painel info Resumo da integração na barra de ferramentas de integração.
   4. Clique em Criar.

   A integração recém-criada é aberta no editor de integração.

4. Na barra de navegação do editor de integração, clique em Acionadores para ver a lista de acionadores disponíveis.
5. Clique e coloque o elemento Acionador da API no criador.

Configure um acionador de API

Para configurar um acionador de API, clique no elemento Acionador de API no editor de integração. O painel de configuração do acionador da API é apresentado com os seguintes campos:

• Etiqueta: o nome visível do acionador da API na sua integração. Pode alterar a etiqueta para um nome à sua escolha.
• Notas: pode adicionar notas ao acionador da API para fornecer informações adicionais sobre o acionador.
• ID do acionador: um ID exclusivo atribuído ao acionador da API no formato api_trigger/TRIGGER_NAME.
• Variáveis de entrada: acione variáveis de entrada específicas que pode usar para definir o payload do pedido para o acionador da API.
  • Para adicionar ou remover variáveis de integração existentes no acionador da API, clique em Modificar e selecione as variáveis necessárias no painel Variáveis de entrada do acionador da API.
  • Para adicionar uma nova variável, especificamente para o acionador da API selecionado, clique em Modificar e selecione + Adicionar nova variável no painel Variáveis de entrada do acionador da API. Para obter informações sobre os tipos de dados suportados, consulte o artigo Tipos de dados de variáveis suportados.
• Variáveis de saída: acione variáveis de saída específicas que pode usar para definir a carga útil da resposta para o acionador da API.
  • Para adicionar ou remover variáveis de integração existentes do acionador da API, clique em Modificar e selecione as variáveis necessárias no painel Variáveis de saída do acionador da API.
  • Para adicionar uma nova variável, especificamente para o acionador de API selecionado, clique em Modificar e selecione + Adicionar nova variável no painel Variáveis de saída do acionador de API. Para obter informações sobre os tipos de dados suportados, consulte o artigo Tipos de dados de variáveis suportados.