Consulte os conetores suportados para a solução Application Integration.

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:

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 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 do 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.

Veja a especificação OpenAPI do seu acionador de API

A integração de aplicações oferece a capacidade de gerar e ver dinamicamente as especificações da OpenAPI das suas integrações publicadas que estão configuradas com um ou mais acionadores de API. Para ver informações sobre como ver a especificação OpenAPI, consulte o artigo Veja a especificação OpenAPI para a sua integração.

Invocar um acionador de API através de uma chamada API

Depois de publicar uma integração com um acionador de API configurado, pode usar o método projects.locations.integrations.execute para invocar esse acionador a partir de qualquer aplicação. Este 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 o seguinte:

  • TIMEOUT_SECONDS: o tempo limite em segundos para a chamada API. Por predefinição, o tempo limite é de 120 segundos. Para ver uma lista de parâmetros de pedidos predefinidos, consulte Parâmetros do sistema.
  • TRIGGER_NAME: o nome do acionador da API na sua integração.
  • PROJECT_ID: o ID do seu projeto Google Cloud .
  • LOCATION: a localização do seu Google Cloud projeto.

Exemplo

O exemplo seguinte invoca uma integração na região us-east1 que contém o acionador 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

Quando usa o acionador da API, o tamanho cumulativo de todas as variáveis de entrada pode ser, no máximo, de 8 MB. Se o tamanho exceder 8 MB, a integração de aplicações não executa a integração e recebe um erro.

Quotas e limites

Para informações sobre quotas e limites, consulte o artigo Quotas e limites.

O que se segue?