Tarea de llamada de extremo de REST

La tarea Llamar a extremo de REST te permite llamar a cualquier API de REST de terceros desde tu integración. La respuesta de la llamada a la API de REST estará disponible en una variable de integración y se puede usar en otras tareas posteriores.

Antes de comenzar

  • A fin de conectarte a un extremo de autenticación para la llamada a la API de REST, asegúrate de haber creado un perfil de OAuth 2.0 o adjuntó una cuenta de servicio administrada por el usuario a tu integración. Si la API no requiere autenticación, el campo del perfil de autenticación del panel de configuración de la tarea puede dejarse en blanco. Para ver una lista de configuraciones, consulta Propiedades de configuración.

    Si tu integración tiene configurados un perfil de OAuth 2.0 y una cuenta de servicio administrada por el usuario, de forma predeterminada, el perfil de OAuth 2.0 se usa para la autenticación. Si no se configuraron el perfil de OAuth 2.0 ni la cuenta de servicio administrada por el usuario, la ejecución falla.

  • Si tu integración tiene una cuenta de servicio adjunta, entonces, según la URL del extremo de REST, otorga el rol de IAM necesario a esa cuenta de servicio. Por ejemplo, si la URL del extremo de REST llama a un servicio de Cloud Storage, otorga el rol de IAM necesario para el servicio de Cloud Storage.

    Para obtener información sobre cómo otorgar roles a una cuenta de servicio, consulta Administra el acceso a las cuentas de servicio.

  • Asegúrate de que los Controles del servicio de VPC NO estén configurados para la integración de Apigee en tu proyecto de Google Cloud.

Configura la tarea Call REST Endpoint

Configura la tarea Llamar al extremo REST:

  1. En la IU de Apigee, selecciona tu organización de Apigee.
  2. Haz clic en Desarrollar > Integraciones.
  3. Elige una integración existente o crea una nueva haciendo clic en Crear integración.

    Si creas una integración nueva, haz lo siguiente:

    1. Escribe un nombre y una descripción en el diálogo Crear integración.
    2. En la lista de regiones compatibles, elige Región para la integración.
    3. Haz clic en Crear.

    Esto abrirá la integración en la página del diseñador de integración.

  4. En la barra de navegación Diseñador de integración, haz clic en +Agregar una tarea o un activador > Tareas para ver la lista de tareas disponibles.
  5. Haz clic y coloca el elemento Llamar a extremo de REST en el editor de integración.
  6. Haz clic en el elemento Llamar a extremo de REST en el diseñador para ver el panel de configuración de tareas Llamar a extremo de REST.
  7. Configura los campos que se muestran con las propiedades de configuración de la tarea, como se detalla en la siguiente tabla.

    Los cambios en las propiedades se guardan de forma automática.

Propiedades de configuración

En la siguiente tabla, se describen las propiedades de configuración de la tarea Llamar a extremo de REST.

Propiedad Tipo de datos Descripción
Etiqueta Cadena Opcional: Agrega una etiqueta para tu tarea.
Authentication Cadena Opcional: Configura y almacena los detalles de autenticación para las conexiones a sistemas externos. Para obtener más información, consulta Crea perfiles de autenticación en la integración de Apigee.
URL base del extremo Cadena URL del extremo de REST sin los parámetros de consulta.
Método HTTP NA Método HTTP para usar.

Puedes seleccionar cualquiera de los siguientes métodos HTTP:

  • BORRAR
  • GET
  • HEAD
  • PATCH
  • POST
  • PUT
Parámetros de la cadena de consulta de URL Clave de cadena de consulta: String

Valor: String

Consulta los parámetros necesarios para la llamada a la API de REST.

Los parámetros de consulta tienen la forma de pares clave-valor en los que la clave es el nombre de la clave y el valor es el valor de clave correspondiente. Para ingresar más de un par clave-valor, haz clic en el ícono de signo más.

Encabezados HTTP Clave de encabezado HTTP: String

Valor: String

Encabezados HTTP obligatorios para la llamada a la API de REST.

Los encabezados HTTP tienen la forma de pares clave-valor en el que la clave es el nombre de la clave y el valor es el valor de la clave correspondiente. Para ingresar más de un par clave-valor, haz clic en el ícono del signo más.

Sigue los redireccionamientos Booleano Sigue los redireccionamientos de las URL.

Puedes seleccionar cualquiera de los siguientes valores:

  • True: Llama a la URL de redireccionamiento si la URL base del extremo se reenvía a otra.
  • False: No llama a la URL redireccionada si la URL base del extremo se reenvía a otra URL.
La tarea debería fallar en error de HTTP Booleano Estrategia de manejo de excepciones cuando falla la llamada a la API de REST. El extremo de REST de la llamada falla si el código de respuesta HTTP es 4xx o 5xx. Para obtener una lista de códigos de error, consulta Códigos de error. Para otros códigos de respuesta HTTP, muestra el código de error y el mensaje de error en la respuesta.

Puedes seleccionar cualquiera de los siguientes valores:

  • True: Muestra una excepción.
  • False: No arroja una excepción. Sin embargo, muestra el código y el mensaje de error en la respuesta.
Encabezado de respuesta (<Task name>) Cadena Encabezado de respuesta sin comprimir de la respuesta de la API de REST.
Cuerpo de la respuesta (<Task name>) Cadena Cuerpo de respuesta sin comprimir de la respuesta de la API de REST.
Estado de la respuesta (<Task name>) Cadena Código de respuesta HTTP y el texto de código correspondiente de la respuesta de la API de REST.

Prácticas recomendadas

Para obtener más información sobre los límites de uso que se aplican a la tarea Llamar a extremo de REST, consulta Límites de uso.

Estrategia de manejo de errores

Una estrategia de manejo de errores de una tarea específica la acción que se debe realizar si la tarea falla debido a un error temporal. Para obtener información sobre cómo usar una estrategia de manejo de errores y conocer los diferentes tipos de estrategias de manejo de errores, consulta Estrategias de manejo de errores.

Para obtener información sobre cómo manejar las estrategias de reintento para los errores 4xx o 5xx, consulta el blog Cómo reintentar la tarea de emisor de REST según el estado de respuesta.