Consulta los conectores compatibles para Application Integration.

Activador de API

Los activadores de API se usan a fin de invocar directamente las ejecuciones para integraciones.

Configurar un activador de API en tu integración te permite hacer lo siguiente:

Para comenzar a usar los activadores de API, consulta la guía de entrega de APIs. En el instructivo, se muestra cómo crear una integración con un activador de API que recibe solicitudes de API para recuperar información del cliente.

Agrega un activador de API

Para agregar un activador de API a tu integración, sigue estos pasos:
  1. En la consola de Google Cloud, ve a la página Application Integration.

    Ir a Application Integration

  2. En el menú de navegación, haz clic en Integraciones.

    Aparecerá la página Lista de integraciones, en la que se enumerarán todas las integraciones disponibles en el proyecto de Google Cloud.

  3. Selecciona una integración existente o haz clic en Crear integración para crear una nueva.

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

    1. Ingresa un nombre y una descripción en el panel Crear integración.
    2. Selecciona una región para la integración.
    3. Selecciona una cuenta de servicio para la integración. Puedes cambiar o actualizar los detalles de la cuenta de servicio de una integración en cualquier momento desde el panel Resumen de la integración en la barra de herramientas de la integración.
    4. Haz clic en Crear.

    Esto abrirá la integración en la página del editor de integración.

  4. En la barra de navegación del editor de integración, haz clic en Activadores para ver la lista de los activadores disponibles.
  5. Haz clic en el elemento activador de API y arrástralo al diseñador.

Configura un activador de API

Para configurar un activador de API, haz clic en el elemento Activador de API en el editor de integración. Aparecerá el panel de configuración del activador de API, que muestra los siguientes campos:

  • Etiqueta: Es el nombre visible del activador de API en tu integración. Puedes cambiar la etiqueta por el nombre que quieras.
  • Notas: Puedes agregar notas al activador de API para proporcionar información adicional sobre él.
  • ID del activador: Es un ID único que se asigna al activador de la API en el formato api_trigger/TRIGGER_NAME.
  • Variables de entrada: Activa variables de entrada específicas que puedes usar para establecer la carga útil de la solicitud para el activador de API.
    • Para agregar o quitar variables de integración existentes al activador de API, haz clic en Modificar y selecciona las variables requeridas del panel Variables de entrada del activador de API.
    • Para agregar una variable nueva, específicamente para el activador de API seleccionado, haz clic en Modificar y selecciona + Agregar variable nueva en el panel Variables de entrada del activador de API. Para obtener información sobre los tipos de datos compatibles, consulta Tipos de datos de variables admitidos.
  • Variables de salida: Activa variables de salida específicas que puedes usar para establecer la carga útil de respuesta del activador de API.
    • Para agregar o quitar variables de integración existentes al activador de API, haz clic en Modificar y selecciona las variables requeridas del panel Variables de salida del activador de API.
    • Para agregar una variable nueva, específicamente para el activador de API seleccionado, haz clic en Modificar y selecciona + Agregar variable nueva en el panel Variables de salida del activador de API. Para obtener información sobre los tipos de datos compatibles, consulta Tipos de datos de variables compatibles.

Consulta la especificación de OpenAPI de tu activador de API

Application Integration permite generar y ver de forma dinámica las especificaciones de OpenAPI de tus integraciones publicadas que están configuradas con uno o más activadores de API. Para obtener información sobre cómo ver la especificación de OpenAPI, consulta Cómo ver la especificación de OpenAPI para tu integración.

Cómo invocar un activador de API con una llamada a la API

Después de publicar una integración que tenga configurado un activador de API, puedes usar el método projects.locations.integrations.execute para invocar ese activador desde cualquier aplicación. Este método activa la ejecución en el modo síncrono.

Sintaxis

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Reemplaza lo siguiente:

  • TIMEOUT_SECONDS: Es el tiempo de espera en segundos de la llamada a la API. De forma predeterminada, el tiempo de espera es de 120 segundos. Para obtener una lista del conjunto predefinido de parámetros de solicitud, consulta Parámetros del sistema.
  • TRIGGER_NAME: Es el nombre del activador de API en tu integración.
  • PROJECT_ID: El ID de tu proyecto de Google Cloud .
  • LOCATION: Es la ubicación de tu proyecto de Google Cloud .

Ejemplo

En el siguiente ejemplo, se invoca una integración en la región us-east1 que contiene el activador de la API de test_API_1 en el proyecto de Google Cloud demo-project:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

Consideraciones

Cuando se usa el activador de API, el tamaño acumulativo de todas las variables de entrada puede ser de un máximo de 8 MB. Si el tamaño supera los 8 MB, la Application Integration no ejecuta la integración y recibirás un error.

Cuotas y límites

Para obtener más información sobre las cuotas y los límites, consulta Cuotas y límites.

¿Qué sigue?