Consulte os conectores compatíveis com a integração de aplicativos.

Gatilho da 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 integração permite fazer o seguinte:

Para começar a usar os acionadores de API, consulte o tutorial Fulfillment de API. O tutorial mostra como criar uma integração com um acionador 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 à 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 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. É 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.

    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 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 acionador da API, clique no elemento Gatilho da API no editor de integração. O painel de configuração do acionador da API aparece mostrando os seguintes campos:

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

Conferir a especificação OpenAPI do acionador da API

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

Invocar um acionador 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 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" \
    -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 conferir uma lista de conjuntos predefinidos de parâmetros de solicitação, consulte Parâmetros do sistema.
  • TRIGGER_NAME: o nome do acionador da API na integração.
  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: o local do seu Google Cloud projeto.

Exemplo

O exemplo a seguir invoca uma integração na região us-east1 que contém o acionador 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" \
    -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 será executada e você receberá um erro.

Cotas e limites

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

A seguir