Consulte os conectores compatíveis com o Application Integration.

Gatilho da API

Os acionadores de API são usados para invocar diretamente execuções para integrações. Os acionadores de API podem ser usados no modo síncrono ou assíncrono.

É possível definir o payload de solicitação e resposta para o acionador da API criando variáveis na integração. Para informações sobre como criar uma integração com um gatilho de API que recebe solicitações de API para recuperar informações do cliente, consulte o tutorial de fulfillment da API.

Adicionar um gatilho de API

Para adicionar um gatilho do gatilho da API, siga estas etapas:
  1. No console do Google Cloud, acesse a página Application Integration.

    Acessar o Application Integration

  2. No menu de navegação, clique em Integrations.

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

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

    Caso você esteja criando uma nova integração, siga estas etapas:

    1. Insira 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. Você pode mudar ou atualizar os detalhes da conta de serviço de uma integração a qualquer momento no painel Resumo da integração na barra de ferramentas da integração.
    4. Clique em Criar.

    Isso abre a integração na página do editor de integração.

  4. Na barra de navegação do editor de integração, clique em Gatilhos para ver a lista de gatilhos disponíveis.
  5. Clique e posicione o elemento Acionador de API no designer.

Configurar um gatilho de API

Clique no elemento gatilho da API no editor de integração para visualizar o painel de configuração do gatilho.

O painel de configuração exibe o ID do gatilho, que é um ID gerado por máquina no formato api_trigger/TRIGGER_NAME. Nenhuma configuração adicional é necessária para esse gatilho.

Invocar o acionador de API de um aplicativo

Depois de publicar uma integração com um gatilho de API configurado, use o método projects.locations.integrations.execute para invocar esse gatilho em qualquer aplicativo. Esse método aciona a execução no modo síncrono.

Sintaxe

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Substitua:

  • TRIGGER_NAME: o nome do acionador da API na integração.
  • PROJECT_ID: o ID do projeto do Google Cloud.
  • LOCATION: a localização do seu projeto do Google Cloud.

Exemplo

O exemplo a seguir invoca uma integração na região us-east1 que contém o gatilho da API test_API_1 no projeto demo-project do Google Cloud:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

Considerações

Ao usar o acionador da API, o tamanho cumulativo de todas as variáveis de entrada pode ser no máximo 8 MB. Se o tamanho exceder 8 MB, o Application Integration não executa o integração e receberá um erro.

Cotas e limites

Para informações sobre o assunto, consulte Cotas e limites.

A seguir