Consulta los conectores compatibles con Application Integration.

Activador de API

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

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

Para empezar a usar los activadores de API, consulta el tutorial sobre cumplimiento de API. En el tutorial se explica cómo crear una integración con un activador de API que recibe solicitudes de API para obtener información de los clientes.

Añadir un activador de API

Para añadir un activador de API a tu integración, sigue estos pasos:
  1. En la Google Cloud consola, ve a la página Integración de aplicaciones.

    Ir a Application Integration

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

    Aparecerá la página Lista de integraciones, donde se muestran todas las integraciones disponibles en el proyecto de Google Cloud.

  3. Seleccione una integración o haga clic en Crear integración para crear una.

    Si vas a crear una integración:

    1. Escribe 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. Puede 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 de la barra de herramientas de integración.
    4. Haz clic en Crear.

    La integración que acabas de crear se abre en el editor de integraciones.

  4. En la barra de navegación del editor de integraciones, haga clic en Activadores para ver la lista de activadores disponibles.
  5. Haz clic en el elemento Activador de API y colócalo en el diseñador.

Configurar un activador de API

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

  • Etiqueta: el nombre visible del activador de la API en tu integración. Puedes cambiar la etiqueta por el nombre que quieras.
  • Notas: Puede añadir notas al activador de la API para proporcionar información adicional sobre el activador.
  • ID de activador: ID único asignado al activador de la API con el formato api_trigger/TRIGGER_NAME.
  • Variables de entrada: activa variables de entrada específicas que puedes usar para definir la carga útil de la solicitud del activador de la API.
    • Para añadir o quitar variables de integración del activador de API, haga clic en Modificar y seleccione las variables que quiera en el panel Variables de entrada del activador de API.
    • Para añadir una variable específica para el activador de API seleccionado, haga clic en Modificar y seleccione + Añadir nueva variable en el panel Variables de entrada del activador de API. Para obtener información sobre los tipos de datos admitidos, consulta Tipos de datos de variables admitidos.
  • Variables de salida: activa variables de salida específicas que puedes usar para definir la carga útil de la respuesta del activador de API.
    • Para añadir o quitar variables de integración del activador de API, haga clic en Modificar y seleccione las variables que quiera en el panel Variables de salida del activador de API.
    • Para añadir una variable nueva específicamente para el activador de API seleccionado, haga clic en Modificar y seleccione + Añadir variable nueva en el panel Variables de salida del activador de API. Para obtener información sobre los tipos de datos admitidos, consulta Tipos de datos de variables admitidos.

Ver la especificación de OpenAPI de un activador de API

Integración de aplicaciones permite generar y ver de forma dinámica las especificaciones de OpenAPI de las integraciones publicadas que estén configuradas con uno o varios activadores de API. Para obtener información sobre cómo ver la especificación de OpenAPI, consulta Ver la especificación de OpenAPI de tu integración.

Invocar un activador de API mediante una llamada a la API

Una vez que hayas publicado una integración que tenga configurado un activador de API, podrás 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"

Haz los cambios siguientes:

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

Ejemplo

En el siguiente ejemplo se invoca una integración en la región us-east1 que contiene el activador de la API 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"

Cuestiones importantes

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

Cuotas y límites

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

Siguientes pasos