A tarefa Chamar REST do endpoint permite chamar qualquer API REST de terceiros a partir da sua integração. A resposta da chamada da API REST estará disponível em uma variável de integração e poderá ser usada em outras tarefas downstream.
Se a integração tiver um perfil OAuth 2.0 e uma conta de serviço gerenciada pelo usuário configurados, o perfil OAuth 2.0 será usado para a autenticação por padrão. Se você não tiver configurado a conta de serviço gerenciada pelo usuário ou o perfil do OAuth 2.0, a execução falhará.
Se a integração tiver uma conta de serviço anexada, conceda o papel necessário do IAM a essa conta com base no URL do endpoint REST. Por exemplo, se o URL do endpoint REST chamar um serviço do Cloud Storage, conceda o papel do IAM necessário a esse serviço.
A página Integrações aparece listando todas as integrações disponíveis no projeto do Google Cloud.
Selecione uma integração ou clique em Criar integração para criar uma.
Caso você esteja criando uma nova integração, siga estas etapas:
Digite um nome e uma descrição no painel Criar integração.
Selecione uma região para a integração.
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çãoinfo na barra de ferramentas de integração.
Clique em Criar. A integração recém-criada é aberta no editor de integração.
Na barra de navegação do editor de integração, clique em Tarefas para conferir a lista de tarefas e conectores disponíveis.
Clique e coloque o elemento Call REST Endpoint no editor de integração.
Clique no elemento Call REST Endpoint no designer para visualizar o painel de configuração de tarefas Call REST Endpoint.
Configure os campos exibidos usando as propriedades de configuração da tarefa, conforme detalhado na tabela abaixo.
As alterações nas propriedades são salvas automaticamente.
Propriedades de configuração
A tabela a seguir descreve as propriedades de configuração da tarefa Call REST Endpoint.
URL do endpoint REST sem os parâmetros da consulta
Método HTTP
NA
Método HTTP a ser usado.
É possível selecionar qualquer um dos métodos HTTP a seguir:
DELETE
GET
HEAD
PATCH
POST
PUT
Parâmetros da string de consulta do URL
Chave da string de consulta: String
Valor: String
Parâmetros de consulta necessários para a chamada da API REST.
Os parâmetros de consulta estão na forma de pares de chave-valor em que a chave é o nome da chave e o valor é o valor de chave correspondente. É possível inserir mais de um par de chave-valor clicando no ícone de adição.
Cabeçalhos HTTP
Chave de cabeçalho HTTP: String
Valor: String
Cabeçalhos HTTP necessários para a chamada da API REST.
Os cabeçalhos HTTP estão na forma de pares de chave-valor em que a chave é o nome da chave e o
valor é o valor de chave correspondente. É possível inserir mais de um par de chave-valor clicando no ícone de adição.
Siga o redirecionamento
Booleano
Siga os redirecionamentos de URL.
É possível selecionar qualquer um dos valores:
Verdadeiro : chama o URL redirecionado se o URL base do endpoint
for encaminhado para outro URL.
Falso: não chama o URL redirecionado se o URL base do endpoint
for encaminhado para outro URL.
A tarefa deve falhar no erro HTTP
Booleano
Estratégia de tratamento de exceções quando a chamada da API REST falhar.
O Call REST Endpoint falhará se o código de resposta HTTP for 4xx ou 5xx. Para conferir uma lista de códigos de erro, consulte Códigos de erro. Para outros códigos de resposta HTTP, retorne o código e a mensagem de erro na resposta.
É possível selecionar qualquer um dos valores:
Verdadeiro: gera uma exceção.
Falso: não gera uma exceção. Mas retorna o
código do erro e a mensagem de erro na resposta.
Cabeçalho de resposta (<Nome da tarefa>)
String
Cabeçalho de resposta não compactado da resposta das APIs REST.
Corpo da resposta (<Nome da tarefa>)
String
Corpo da resposta não compactado da resposta das APIs REST.
Status da resposta (<Nome da tarefa>)
String
O código de resposta HTTP e o texto de código correspondente na resposta das APIs REST.
Práticas recomendadas
Para informações sobre os limites de uso que se aplicam à tarefa Chamar o endpoint REST, consulte Limites de uso.
Estratégia de solução de erros
A estratégia de solução de erros para uma tarefa especifica a ação a ser realizada se a tarefa falhar
devido a um erro temporário. Para mais informações sobre como usar uma estratégia de tratamento de erros e conhecer os diferentes tipos de estratégias de tratamento de erros, consulte Estratégias de tratamento de erros.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-03 UTC."],[[["\u003cp\u003eThe \u003cstrong\u003eCall REST Endpoint\u003c/strong\u003e task enables integrations to interact with any third-party REST API, with the response data being accessible for use in subsequent tasks.\u003c/p\u003e\n"],["\u003cp\u003eThis task is restricted to calling endpoints accessible over the public internet and cannot connect to resources within private networks like VPCs.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for REST API calls requires either a pre-configured OAuth 2.0 profile or an attached user-managed service account, however, authentication isn't needed if it's not required by the API.\u003c/p\u003e\n"],["\u003cp\u003eThe task supports various HTTP methods (DELETE, GET, HEAD, PATCH, POST, PUT) and allows for the configuration of URL query string parameters and HTTP headers.\u003c/p\u003e\n"],["\u003cp\u003eThe task has a response limit of 50 MB, and you can manage error handling, with the ability to throw exceptions or return error codes and messages based on HTTP status codes.\u003c/p\u003e\n"]]],[],null,["# Call REST Endpoint task\n\nSee the [supported connectors](/integration-connectors/docs/connector-reference-overview) for Application Integration.\n\nCall REST Endpoint task\n=======================\n\nThe **Call REST Endpoint** task lets you call any third-party REST\nAPI from your integration. The response from the REST API call will be available to\nyou in an integration variable and can be used in other down-stream tasks.\n| **Note:**\n|\n| - The network configuration of the **Call REST Endpoint** task allows it to call endpoints only available over the public internet. Hence, the task can't connect to hosts or IPs that reside only within a private network such as a VPC, even if that VPC is peered with your other Google Cloud services such as Apigee X.\n| - This task can process a maximum of 50 MB of REST response.\n\nBefore you begin\n----------------\n\n- To connect to an authentication endpoint for the REST API call, ensure that you have either [created\n an OAuth 2.0 profile](/application-integration/docs/configuring-auth-profile#createAuthProfile) or [attached a user-managed service account](/application-integration/docs/access-control#add-service-account) to your integration. If your API does not require authentication, then the **Authentication profile** field in the task configuration pane can be left empty. To see a list of configurations, see [Configuration properties](#params).\n\n If your integration has both OAuth 2.0 profile and a user-managed service account configured, then by default the OAuth 2.0 profile is used for authentication. If neither OAuth 2.0 profile nor user-managed service account is configured, then the execution fails.\n- If your integration has a service account attached, then based on the REST endpoint URL, grant the required IAM role to that service account. For example, if your REST endpoint URL calls a Cloud Storage service, then grant the required IAM role for the Cloud Storage service. For information about granting roles to a service account, see [Manage access to service accounts](/iam/docs/manage-access-service-accounts).\n\n- Ensure that [VPC Service Controls](/application-integration/docs/vpc-service-controls) is **NOT** setup for Application Integration in your Google Cloud project. **Warning:** **Cloud Function** does not function or stops functioning if [VPC Service Controls](/application-integration/docs/vpc-service-controls) is setup for Application Integration in your Google Cloud project.\n\nConfigure the Call REST Endpoint task\n-------------------------------------\n\nTo configure the **Call REST Endpoint** task:\n\n1. In the Google Cloud console, go to the **Application Integration** page.\n\n [Go to Application Integration](https://console.cloud.google.com/integrations)\n2. In the navigation menu, click **Integrations** .\n\n\n The **Integrations** page appears listing all the integrations available in the Google Cloud project.\n3. Select an existing integration or click **Create integration** to create a new one.\n\n\n If you are creating a new integration:\n 1. Enter a name and description in the **Create Integration** pane.\n 2. Select a region for the integration. **Note:** The **Regions** dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, click **Enable Region** . See [Enable new region](/application-integration/docs/enable-new-region) for more information.\n 3. Select a service account for the integration. You can change or update the service account details of an integration any time from the info **Integration summary** pane in the integration toolbar. **Note:** The option to select a service account is displayed only if you have enabled integration governance for the selected region.\n 4. Click **Create** . The newly created integration opens in the *integration editor*.\n\n\n4. In the *integration editor* navigation bar, click **Tasks** to view the list of available tasks and connectors.\n5. Click and place the **Call REST Endpoint** element in the integration editor.\n6. Click the **Call REST Endpoint** element on the designer to view the **Call REST Endpoint** task configuration pane.\n7. Configure the displayed fields using the [configuration properties](#params) of the task as detailed in the table below.\n\n\n Changes to the properties are saved automatically.\n | **Note:** If you update the authentication profile for a **Call REST Endpoint** task, and test the integration without publishing the changes, the integration uses the old authentication profile. To ensure that the integration uses the updated authentication profile, you must [publish the integration](https://cloud.google.com/application-integration/docs/test-publish-integrations) before testing.\n\nConfiguration properties\n------------------------\n\n\nThe following table describes the configuration properties of the **Call REST Endpoint** task.\n\nBest practices\n--------------\n\nFor information about the usage limits that apply to the **Call REST Endpoint** task, see [Usage limits](/application-integration/docs/quotas#usage-limits).\n\nError handling strategy\n-----------------------\n\n\nAn error handling strategy for a task specifies the action to take if the task fails due to a [temporary error](/application-integration/docs/error-handling). For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see [Error handling strategies](/application-integration/docs/error-handling-strategy).\n\nTo learn how to handle retry strategies for `4xx` or `5xx` errors, see the [How to retry Rest Caller Task based on Response Status](https://www.googlecloudcommunity.com/gc/Integration-Services/How-to-retry-Rest-Caller-Task-based-on-Response-Status/m-p/618079) blog.\n\nQuotas and limits\n-----------------\n\nFor information about quotas and limits, see [Quotas and limits](/application-integration/docs/quotas).\n\nWhat's next\n-----------\n\n- Learn about [all tasks and triggers](/application-integration/docs/all-triggers-tasks).\n- Learn how to [test and publish an integration](/application-integration/docs/test-publish-integrations).\n- Learn about [error handling](/application-integration/docs/error-handling-strategy).\n- Learn about [integration execution logs](/application-integration/docs/introduction-logs)."]]
