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

Tarefa "Chamar endpoint REST"

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.

Observação:

• A configuração de rede da tarefa Call REST Endpoint permite que ela chame endpoints disponíveis apenas pela Internet pública. Portanto, a tarefa não se conecta a hosts ou IPs que residam apenas em uma rede privada, como uma VPC, mesmo se essa VPC estiver conectada com outros serviços do Google Cloud, como a Apigee X.
• Esta tarefa pode processar no máximo 50 MB de resposta REST.

Antes de começar

• A fim de se conectar a um endpoint de autenticação para a chamada da API REST, verifique se você criou um perfil OAuth 2.0 ou anexou uma conta de serviço gerenciada pelo usuário à integração. Se a API não exigir autenticação, o campo Perfil de autenticação no painel de configurações da tarefa poderá ser deixado em branco. Para uma lista de configurações, consulte Propriedades de configuração.

  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.

  Para informações sobre como conceder papéis a uma conta de serviço, consulte Gerenciar o acesso a contas de serviço.

• Verifique se o VPC Service Controls NÃO está configurado para o Application Integration no seu projeto do Google Cloud.
  Aviso: a função do Cloud não vai funcionar ou vai parar de funcionar se o VPC Service Controls estiver configurado para a integração de aplicativos no seu projeto do Google Cloud.

Configurar a tarefa Call REST Endpoint

Para configurar a tarefa Call REST Endpoint:

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 Integrações aparece listando 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.
      Observação: o menu suspenso Regiões lista apenas as regiões provisionadas no projeto do Google Cloud. Para provisionar uma nova região, clique em Ativar região. Consulte Ativar nova região para obter mais informações.
   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.
      Observação: a opção de selecionar uma conta de serviço só vai aparecer se você tiver ativado a governança de integração para a região selecionada.
   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 Tarefas para conferir a lista de tarefas e conectores disponíveis.
5. Clique e coloque o elemento Call REST Endpoint no editor de integração.
6. Clique no elemento Call REST Endpoint no designer para visualizar o painel de configuração de tarefas Call REST Endpoint.
7. 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.

Propriedade	Tipo de dado	Descrição
Rótulo	String	Opcional: adicione um rótulo à tarefa.
Authentication	String	Opcional: configura e armazena os detalhes de autenticação para conexões com sistemas externos. Para mais informações, consulte Criar perfis de autenticação na integração de aplicativos.
URL base do endpoint	String	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. Observação: para erros não relacionados à chamada da API REST, como URL incorreto, a tarefa sempre falha, independentemente da configuração dessa opção. É 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.

Para saber como lidar com estratégias de repetição para erros 4xx ou 5xx, consulte o blog Como repetir a tarefa de chamadas em repouso com base no status da resposta.

Cotas e limites

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

A seguir

• Saiba mais sobre todas as tarefas e acionadores.
• Saiba como testar e publicar uma integração.
• Saiba mais sobre o tratamento de erros.
• Saiba mais sobre os registros de execução de integração.