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.

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 a integração da Apigee no projeto do Google Cloud.

Configurar a tarefa Call REST Endpoint

Para configurar a tarefa Call REST Endpoint:

  1. Na IU da Apigee, selecione sua organização da Apigee.
  2. Clique em Desenvolver > Integrações.
  3. Selecione uma integração existente ou clique em Criar integração.

    Caso você esteja criando uma nova integração, siga estas etapas:

    1. Digite um nome e uma descrição na caixa de diálogo Criar integração.
    2. Selecione uma Região para a integração na lista de regiões compatíveis.
    3. Clique em Criar.

    Isso abre a integração na página do designer de integração.

  4. Na barra de navegação do designer de integração, clique em +Adicionar uma tarefa/gatilho> Tarefas para conferir a lista de tarefas 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 da Apigee.
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.

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