Entrega de solicitudes a la API

---

En este instructivo, se describe un caso de uso sobre cómo puedes usar la integración de aplicaciones para enrutar y recuperar información para una solicitud a la API de entrada.

Descripción general

En este instructivo, crearás una integración con un activador de API que reciba solicitudes de API para recuperar información del cliente. Según la ubicación de la solicitud a la API, la integración recupera los detalles del cliente desde una base de datos MySQL o una base de datos Oracle.

Objetivos

En este instructivo, se muestra cómo completar las siguientes tareas en tu integración:

• Agregar un activador de API
• Agrega y configura las tareas de Connectors para las conexiones de MySQL y Oracle.
• Agrega y configura las tareas de asignación de datos para extraer y asignar la carga útil de la API.

Costos

En este instructivo, usarás los siguientes componentes facturables de Google Cloud:

• Integración de aplicaciones
• Conectores de Integration
• Secret Manager

Las instrucciones de este instructivo están diseñadas para que el uso de los recursos se mantenga dentro de los límites del nivel Siempre gratuito de Google Cloud.

Cuando finalices las tareas que se describen en este documento, puedes borrar los recursos que creaste para evitar que continúe la facturación. Para obtener más información, consulta Cómo realizar una limpieza.

Antes de comenzar

1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

4. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the following roles to the service account: Secret Manager Viewer (roles/secretmanager.viewer), Secret Manager Secret Accessor (roles/secretmanager).

      To grant a role, find the Select a role list, then select the role.

      To grant additional roles, click Add another role and add each additional role.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
   6. Click Continue.

   7. Click Done to finish creating the service account.

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

7. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the following roles to the service account: Secret Manager Viewer (roles/secretmanager.viewer), Secret Manager Secret Accessor (roles/secretmanager).

      To grant a role, find the Select a role list, then select the role.

      To grant additional roles, click Add another role and add each additional role.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
   6. Click Continue.

   7. Click Done to finish creating the service account.

Nota: Todas las demás APIs obligatorias de Google Cloud, como la API de Application Integration, la API de Secret Manager y la API de Connectors, se habilitan durante la configuración de Application Integration. Para obtener más detalles, consulta Configura Application Integration.

Prepare el entorno

Configura una base de datos de MySQL

Conéctate a tu servidor MySQL y crea una base de datos y una tabla para usar en este instructivo. En este instructivo, se usa una base de datos que contiene una tabla llamada Customers con las siguientes filas:

  +-------------+---------------+--------------------+------------------+
  | customer_id | customer_name | customer_emailID   | customer_city    |
  +-------------+---------------+--------------------+------------------+
  |           1 | Alex          | [e-mail]   | New York         |
  |           2 | Dana          | [e-mail]   | Seattle          |
  +-------------+---------------+--------------------+------------------+
  

Para obtener información sobre cómo crear y usar una base de datos de MySQL, consulta la documentación de MySQL.

Configura una base de datos de Oracle

Conéctate a tu base de datos de Oracle y crea una tabla para usarla en este instructivo. En este instructivo, se usa una base de datos que contiene una tabla de SQL llamada Customers con las siguientes filas:

  +-------------+---------------+--------------------+------------------+
  | customer_id | customer_name | customer_emailID   | customer_city    |
  +-------------+---------------+--------------------+------------------+
  |           1 | Amal          | [e-mail]   | Delhi            |
  |           2 | Hao           | [e-mail]   | Beijing          |
  +-------------+---------------+--------------------+------------------+
  

Para obtener información sobre cómo crear y usar una base de datos de Oracle, consulta la documentación de Oracle.

Configurar conexiones

Para este instructivo, debes configurar las siguientes conexiones en Conectores de integración:

Nota: Te recomendamos que crees las siguientes conexiones en la región us-central1(lowa).

Conexión a MySQL

Configura una conexión de MySQL en los conectores de integración para obtener las entidades de las tablas Customer. Para obtener información sobre cómo configurar un conector MySQL, consulta Conector MySQL.

Conexión a la base de datos de Oracle

Configura una conexión de la base de datos de Oracle en los conectores de integración para obtener las entidades de las tablas Customer. Si deseas obtener información para configurar un conector de MySQL, consulta Conector de base de datos de Oracle.

Crea la integración

Para crear una integración nueva, 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 Integraciones.
3. Haz clic en Crear integración y proporciona los siguientes detalles en la página Crear integración:
   1. Nombre de la integración: Ingresa api_fulfilment.
   2. Descripción (Description): Ingresa Demo integration created for tutorial.
   3. Región: Selecciona us-central1 en la lista de regiones compatibles.
   4. Haz clic en Crear para abrir el editor de integración.

Configura el activador de integración

Una vez que hayas creado correctamente la integración, puedes agregar y configurar un activador de integración que la invoque para un evento identificado.

En este instructivo, se usa un activador de API para invocar la integración para cada solicitud a la API nueva. Para agregar y configurar un activador de API en tu integración de api_fulfilment, haz lo siguiente:

1. En el editor de integración, haz clic en Activadores para ver una lista de los activadores disponibles.
2. Haz clic y coloca el elemento activador de API en el editor de integración.

   La integración de aplicaciones propaga automáticamente la etiqueta, el nombre y el ID del activador. El ID de activador es un ID generado por una máquina, en el formato api_trigger/TRIGGER_NAME, que se usa en la solicitud a la API.

No se requiere ninguna configuración adicional para este activador.

Crea variables de integración

Las variables de integración son similares a las variables que se usan en un lenguaje de programación. Los datos en las variables se pueden leer y escribir durante la ejecución de la integración. Si deseas crear las variables necesarias para este instructivo, haz lo siguiente:

1. Haz clic en (Panel de activación) en la barra de navegación del diseñador para abrir el panel Variables.
2. Haz clic en + Crear y crea las siguientes variables de integración:

   Nombre de la variable	Tipo de datos	Tipo de variable
   location	STRING	Entrada para la integración
   customer_id	STRING	Entrada a la integración
   customer_record	JSON	Resultado de la integración

Cómo recuperar datos del cliente desde la base de datos de MySQL

Si la solicitud a la API de entrada proviene de la ubicación US, haz lo siguiente para recuperar los datos del cliente de la base de datos de MySQL.

Conéctate a la base de datos de MySQL

Realiza los siguientes pasos para agregar y configurar una tarea de Conectores a fin de recuperar los detalles de los clientes desde la tabla Clientes de MySQL:

1. En el editor de integración, haz clic en Tasks para mostrar una lista de tareas disponibles.
2. Haz clic y coloca el elemento Conectores en el editor de integración.
3. Selecciona el elemento de la tarea Conectores en el diseñador para ver la tarea Conectores. de configuración.
4. Haz clic en y cambia el nombre de la etiqueta Conectores a Fetch MySQL Data.
5. Haz clic en Configurar conector.
6. Haz lo siguiente en la página Editor de tareas de conectores:
   1. En Seleccionar conexión, elige la región us-central1.
   2. Selecciona tu conexión de Salesforce de la lista de conexiones disponibles.
   3. Haz clic en Siguiente.
   4. En Tipo, elige Entidades.
   5. En Configurar entidades/acciones, selecciona Clientes en la lista de entidades disponibles y, luego, selecciona Obtener como Operación.
   6. Haz clic en Listo para completar la configuración de conexión y cerrar el panel.

Asigna el ID de cliente al conector de MySQL

Se usa una tarea de asignación de datos para asignar el ID de cliente al conector de MySQL. Para agregar y configurar la asignación de datos en tu integración, haz lo siguiente:

1. En el editor de integración, haz clic en Tareas para ver una lista de las tareas disponibles.
2. Haz clic y coloca el elemento Asignación de datos en el editor de integración.
3. Selecciona el elemento Asignación de datos en el diseñador para ver el panel de configuración de la tarea.
4. Haz clic en y cambia el nombre de la tarea Asignación de datos a Map to MySQL.
5. Haz clic en Open Data Mapping Editor.

   El Editor de asignación de datos te permite asignar variables de entrada a las variables de salida deseadas con las funciones de transformación disponibles. Entonces, el resultado está disponible como una variable para cualquier otra tarea o activador de integración. Para obtener más detalles variables de asignación, consulta Cómo agregar una asignación.

6. Asigna la variable de entrada del activador (customer_id), la variable de integración al conector generado automáticamente (entityId(Fetch MySQL Data)).

   Una vez que hayas completado la asignación, cierra el panel. Los cambios se guardarán automáticamente.

7. Agrega una conexión perimetral desde la tarea Mapear a MySQL al conector Obtener datos de MySQL.

Recupera detalles de clientes MySQL

Para recuperar los detalles del cliente desde el conector de MySQL, haz lo siguiente:

1. En el editor de integración, haz clic en Tareas para ver una lista de las tareas disponibles.
2. Haz clic y coloca el elemento Asignación de datos en el editor de integración.
3. Haz clic en el elemento Data Mapping en el diseñador para ver el panel de configuración de la tarea.
4. Haz clic en y cambia el nombre de la tarea Asignación de datos a Get MySQL data.
5. Haz clic en Abrir editor de asignación de datos.
6. Asigna la variable de salida de MySQL (connectorOutputPayload (Fetch MySQL Data)) a la variable de integración customer_record.

   Una vez que hayas completado la asignación, cierra el panel. Los cambios se guardarán automáticamente.

7. Agrega una conexión perimetral desde el conector Recuperar datos de MySQL a la tarea Obtener datos de MySQL.

Cómo recuperar datos del cliente desde la base de datos de Oracle

Si la solicitud de la API de entrada proviene de la ubicación APAC, haz lo siguiente para recuperar los datos del cliente de la base de datos de Oracle.

Conéctate a la base de datos de Oracle

Realiza los siguientes pasos para agregar y configurar una tarea de Conectores a fin de recuperar los detalles de los clientes de la tabla Clientes de Oracle:

1. En el editor de integración, haz clic en Tasks para mostrar una lista de tareas disponibles.
2. Haz clic y coloca el elemento Conectores en el editor de integración.
3. Selecciona el elemento de tarea Conectores en el diseñador para ver el panel de configuración de tareas de Conectores.
4. Haz clic en y cambia el nombre de la etiqueta Conectores a Fetch Oracle Data.
5. Haz clic en Configurar conector.
6. Haz lo siguiente en la página Editor de tareas de conectores:
   1. En Seleccionar conexión, elige la región us-central1.
   2. Selecciona tu conexión de Salesforce de la lista de conexiones disponibles.
   3. Haz clic en Siguiente.
   4. En Tipo, elige Entidades.
   5. En Configurar entidades/acciones, selecciona Clientes en la lista de entidades disponibles y, luego, selecciona Obtener como Operación.
   6. Haz clic en Listo para completar la configuración de conexión y cerrar el panel.

Asigna el ID de cliente al conector de Oracle

Para agregar y configurar la asignación de datos en tu integración, haz lo siguiente:

1. En el editor de integración, haz clic en Tareas para ver una lista de las tareas disponibles.
2. Haz clic y coloca el elemento Asignación de datos en el editor de integración.
3. Selecciona el elemento Data Mapping en el diseñador para ver el panel de configuración de la tarea.
4. Haz clic en y cambia el nombre de la tarea de Asignación de datos a Map to Oracle.
5. Haz clic en Open Data Mapping Editor.
6. Asigna la variable de entrada del activador (customer_id), la variable de integración al conector generado automáticamente (entityId(Fetch Oracle Data)).

   Una vez que hayas completado la asignación, cierra el panel. Los cambios se guardarán automáticamente.

7. Agrega una conexión perimetral desde la tarea Mapear a Oracle al conector Obtener datos de Oracle.

Recupera los detalles del cliente de Oracle

Para recuperar los detalles del cliente desde el conector de Oracle, haz lo siguiente:

1. En el editor de integración, haz clic en Tasks para mostrar una lista de tareas disponibles.
2. Haz clic y coloca el elemento Asignación de datos en el editor de integración.
3. Haz clic en el elemento Data Mapping en el diseñador para ver el panel de configuración de la tarea.
4. Haz clic en y cambia el nombre de la tarea de Asignación de datos a Get Oracle data.
5. Haz clic en Abrir editor de asignación de datos.
6. Asigna la variable de salida de Oracle (connectorOutputPayload (Fetch Oracle Data)) a la variable de integración customer_record.

   Una vez que hayas completado la asignación, cierra el panel. Los cambios se guardarán automáticamente.

7. Agrega una conexión perimetral desde el conector Fetch Oracle Data para la tarea Get Oracle data.

Agrega una condición perimetral

Una condición perimetral te permite especificar las condiciones que se deben cumplir para que una integración pase a la tarea conectada por el perímetro. Ahora que agregaste y configuraste las tareas requeridas, puedes agregar una condición de borde para definir el flujo de la integración.

La siguiente condición perimetral controla el flujo de la integración según la variable de integración location:

1. Agrega una conexión perimetral del activador de la API a la tarea Asignar a MySQL con la siguiente condición perimetral:

     $location$ = "US"

2. Agrega otra conexión perimetral del activador de la API a la tarea Asignar a Oracle con la siguiente condición perimetral:

     $location$ = "APAC"

Flujo de integración de muestra

En la siguiente figura, se muestra un diseño de ejemplo de la integración creada con este instructivo.

Publica la integración

Para publicar la integración, haz clic en Publicar en la barra de herramientas del editor de integraciones.

Una vez que publiques tu integración de forma correcta, podrás ver e inspeccionar los registros de ejecución de la integración publicada. Para ver los registros, haz clic en Ver registros de ejecución de esta integración. Aparecerá la página Registros de ejecución.

Prueba la integración

Prueba la integración desde el editor de integraciones

Para probar la integración desde el editor de integración, sigue estos pasos:

1. Haz clic en Probar en la barra de herramientas del editor de integración.

   Aparecerá el panel Probar integración.

2. Se te pedirá que ingreses los valores de prueba para las variables de entrada de integración. Para realizar esta prueba, haz lo siguiente:
   • customer_id: Ingresa 1.
   • location: Ingresa APAC.
3. Haz clic en Probar integración.

La integración se ejecuta correctamente y se muestra el siguiente valor de cliente:

{ 
  "CUSTOMER_ID": 1,
  "CUSTOMER_NAME": "Amal"
  "CUSTOMER_EMAILID": "[e-mail] "
  "CUSTOMER_CITY": "Delhi"
}

Para obtener más información sobre las pruebas, consulta Prueba y publica integraciones.

Prueba con una llamada a la API de REST

Ahora que la integración está publicada y en ejecución, puedes invocarla con la siguiente llamada de REST POST:

URL:

https://integrations.googleapis.com/v1/projects/project-name/locations/-/integrations/api_fulfilment:execute 

Cuerpo de la solicitud:

{"trigger_id":"api_trigger/api_fulfilment_API_1"}

Ejemplo: Realiza una solicitud a la API con entradas personalizadas

Nota: En el siguiente ejemplo, se usa curl, que suele venir preinstalado para los sistemas operativos Linux y macOS. Si no tienes curl, puedes descargarlo de la página de actualizaciones y descargas de curl.

curl -v -X POST -H "Content-Type: application/json" 'https://integrations.googleapis.com/v1/projects/connectors-ip-test/locations/us-central1/integrations/api-fulfillment-integration:execute' -H "Authorization: Bearer $(gcloud auth AUTH_PROFILE)" -d  '{ "triggerId": "api_trigger/api-fulfillment-integration_API_1", "inputParameters": { "customer_id": {"string_value": 1}, "location" : {"string_value" : "US"}} }'

La API muestra la respuesta de ejecución de la integración que contiene todo el siguiente JSON:

  { 
    "CUSTOMER_ID": 2,
    "CUSTOMER_NAME": "Dana"
    "CUSTOMER_EMAILID": "[e-mail] "
    "CUSTOMER_CITY": "Seattle"
  }
  

Limpia

Para evitar que se generen cargos en tu cuenta de Google Cloud por los recursos que usaste en este instructivo, deja de publicar la integración y borra las conexiones creadas en los Conectores de integración.

• Para anular la publicación de esta integración, haz clic en Anular publicación en la barra de herramientas del editor de integración. Consulta Borra integraciones para obtener más información.
• Para obtener información sobre cómo borrar una conexión, consulta Administra conectores.