Consulte os conetores suportados para a solução Application Integration.
Tarefa de ponto final REST de chamadas
A tarefa Chamar ponto final REST permite-lhe chamar qualquer API REST de terceiros a partir da sua integração. A resposta da chamada da API REST vai estar disponível para si numa variável de integração e pode ser usada noutras tarefas posteriores.
Antes de começar
- Para se ligar a um ponto final de autenticação para a chamada da API REST, certifique-se de que criou
um perfil do OAuth 2.0 ou anexou uma conta de serviço gerida pelo utilizador à sua integração. Se a sua API não exigir autenticação, pode deixar o campo Perfil de autenticação no painel de configuração da tarefa vazio. Para ver uma lista de configurações, consulte Propriedades de configuração.
Se a sua integração tiver um perfil do OAuth 2.0 e uma conta de serviço gerida pelo utilizador configurados, por predefinição, o perfil do OAuth 2.0 é usado para autenticação. Se não estiver configurado um perfil do OAuth 2.0 nem uma conta de serviço gerida pelo utilizador, a execução falha.
- Se a sua integração tiver uma conta de serviço anexada, conceda a função do IAM necessária a essa conta de serviço com base no URL do ponto final REST. Por exemplo, se o URL do seu ponto final REST chamar um serviço do Cloud Storage, conceda a função do IAM necessária para o serviço do Cloud Storage.
Para obter informações sobre a atribuição de funções a uma conta de serviço, consulte o artigo Faça a gestão do acesso às contas de serviço.
- Certifique-se de que o VPC Service Controls NÃO está configurado para a integração de aplicações no seu Google Cloud projeto.
Configure a tarefa de ponto final REST de chamadas
Para configurar a tarefa Call REST Endpoint:
- Na Google Cloud consola, aceda à página Application Integration.
- No menu de navegação, clique em Integrações.
A página Integrações é apresentada com todas as integrações disponíveis no projeto do Google Cloud.
- Selecione uma integração existente ou clique em Criar integração para criar uma nova.
Se estiver a criar uma nova integração:
- Introduza 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. 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.
- 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 Tasks para ver a lista de tarefas e conetores disponíveis.
- Clique e coloque o elemento Chamar ponto final REST no editor de integração.
- Clique no elemento Chamar ponto final REST no criador para ver o painel de configuração da tarefa Chamar ponto final REST.
- Configure os campos apresentados através das propriedades de configuração da tarefa, conforme detalhado na tabela abaixo.
As alterações às propriedades são guardadas automaticamente.
Propriedades de configuração
A tabela seguinte descreve as propriedades de configuração da tarefa Call REST Endpoint.
Propriedade | Tipo de dados | Descrição |
Etiqueta | String | Opcional: adicione uma etiqueta à sua tarefa. |
Autenticação | String | Opcional: configura e armazena os detalhes de autenticação para ligações a sistemas externos. Para mais informações, consulte o artigo Crie perfis de autenticação na integração de aplicações. |
URL base do ponto final | String | URL do ponto final REST sem os parâmetros de consulta. |
Método HTTP | NA | Método HTTP a usar.
Pode selecionar qualquer um dos seguintes métodos HTTP:
|
Parâmetros de string de consulta de 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 no formato de pares de chave-valor, em que a chave é o nome da chave e o valor é o valor da chave correspondente. Pode introduzir mais do que um par de chave-valor clicando no ícone de mais. |
Cabeçalhos HTTP | Chave do cabeçalho HTTP: String
Valor: String |
Cabeçalhos HTTP necessários para a chamada da API REST.
Os cabeçalhos HTTP estão no formato de pares de chave-valor, em que a chave é o nome da chave e o valor é o valor da chave correspondente. Pode introduzir mais do que um par de chave-valor clicando no ícone de mais. |
Seguir redirecionamentos | Booleano | Seguir redirecionamentos de URL.
Pode selecionar qualquer um dos valores:
|
A tarefa deve falhar no erro de HTTP | Booleano | Estratégia de processamento de exceções quando a chamada da API REST falha.
O ponto final de REST de chamadas falha se o código de resposta HTTP for 4xx ou 5xx . Para ver uma lista de códigos de erro, consulte o artigo Códigos de erro. Para outros códigos de resposta HTTP, devolva o código de erro e a mensagem de erro na resposta.
Pode selecionar qualquer um dos valores:
|
Cabeçalho da resposta (<Task name>) | String | Cabeçalho da resposta não comprimido da resposta das APIs REST. |
Corpo da resposta (<Task name>) | String | Corpo da resposta não comprimido da resposta das APIs REST. |
Estado da resposta (<Task name>) | String | Código de resposta HTTP e o texto do código correspondente da resposta das APIs REST. |
Práticas recomendadas
Para informações sobre os limites de utilização que se aplicam à tarefa Call REST Endpoint, consulte Limites de utilização.
Estratégia de processamento de erros
Uma estratégia de processamento de erros para uma tarefa especifica a ação a realizar se a tarefa falhar devido a um erro temporário. Para obter informações sobre como usar uma estratégia de processamento de erros e conhecer os diferentes tipos de estratégias de processamento de erros, consulte o artigo Estratégias de processamento de erros.
Para saber como processar estratégias de repetição para erros 4xx
ou 5xx
, consulte o blogue Como repetir a tarefa do autor da chamada REST com base no estado da resposta.
Quotas e limites
Para informações sobre quotas e limites, consulte o artigo Quotas e limites.
O que se segue?
- Saiba mais sobre todas as tarefas e acionadores.
- Saiba como testar e publicar uma integração.
- Saiba mais sobre o processamento de erros.
- Saiba mais sobre os registos de execução da integração.