Gatilho da API

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

Ao configurar um gatilho de API na integração, você pode fazer o seguinte:

Para ajudar você a começar a usar os gatilhos de API, consulte o tutorial Fulfillment de API. O tutorial mostra como criar uma integração com um gatilho de API que recebe solicitações de API para recuperar informações do cliente.

Adicionar um gatilho de API

Para adicionar um gatilho de API à sua integração, 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 Integrações.

    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.

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

    1. Digite 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. É possível 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 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 conferir a lista de acionadores disponíveis.
  5. Clique e posicione o elemento Acionador de API no designer.

Configurar um gatilho de API

Para configurar um gatilho da API, clique no elemento Gatilho da API no editor de integração. O painel de configuração do gatilho da API aparece com os seguintes campos:

  • Rótulo:o nome visível do gatilho da API na sua integração. Você pode mudar o marcador para o nome que quiser.
  • Observações:é possível adicionar observações ao acionador de API para fornecer mais informações sobre ele.
  • ID do gatilho:um ID exclusivo atribuído ao gatilho da API no formato api_trigger/TRIGGER_NAME.
  • Variáveis de entrada:variáveis de entrada específicas do gatilho que podem ser usadas para definir o payload da solicitação do gatilho da API.
    • Para adicionar ou remover variáveis de integração do gatilho de API, clique em Modificar e selecione as variáveis necessárias no painel Variáveis de entrada do gatilho de API.
    • Para adicionar uma variável específica para o acionador de API selecionado, clique em Modificar e selecione + Adicionar nova variável no painel Variáveis de entrada do acionador de API. Para saber mais sobre os tipos de dados de variáveis compatíveis, consulte Tipos de dados de variáveis compatíveis.
  • Variáveis de saída:acionam variáveis de saída específicas que podem ser usadas para definir o payload de resposta do acionador da API.
    • Para adicionar ou remover variáveis de integração do gatilho de API, clique em Modificar e selecione as variáveis necessárias no painel Variáveis de saída do gatilho de API.
    • Para adicionar uma variável específica ao 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 informações sobre os tipos de dados de variáveis compatíveis, consulte Tipos de dados de variáveis compatíveis.

Ver a especificação OpenAPI para o gatilho de API

Application Integration permite gerar e visualizar dinamicamente as especificações OpenAPI das integrações publicadas que estão configuradas com um ou mais gatilhos de API. Para saber como ver a especificação OpenAPI, consulte Ver a especificação OpenAPI da sua integração.

Invocar um gatilho de API usando uma chamada de API

Depois de publicar uma integração com um gatilho de API configurado, use o método projects.locations.integrations.execute para invocar esse gatilho de 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" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Substitua:

  • TIMEOUT_SECONDS: o tempo limite em segundos para a chamada de API. Por padrão, o tempo limite é de 120 segundos. Para ver uma lista de parâmetros de solicitação predefinidos, consulte Parâmetros do sistema.
  • TRIGGER_NAME: o nome do gatilho da API na sua integração.
  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: o local do projeto 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 do Google Cloud demo-project:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -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, Application Integration não executará a integração e você vai receber um erro.

Cotas e limites

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

A seguir