Apigee Integration con un activador de API

En esta guía de inicio rápido, se muestra cómo crear una integración de muestra en la integración de Apigee. En los pasos que se indican a continuación, se describe cómo configurar el activador, las tareas, los perímetros, las variables y las asignaciones de datos necesarias para ejecutar una integración completa.

En esta guía de inicio rápido, recuperarás la cantidad de vistas de página de una API pública, transformarás los datos en un formato usable y enviarás la lista resultante en un correo electrónico, todo desde el diseñador de integración.

Cómo crear una integración nueva

Para crear una integración nueva, sigue estos pasos:

  1. En la IU de Apigee, selecciona tu organización de Apigee.
  2. Haz clic en Desarrollar > Integraciones.
  3. Haz clic en Crear integración.
  4. Ingresa un nombre y una descripción en el diálogo Crear integración.

    Para esta guía de inicio rápido, ingresa el nombre my-test-integration y la descripción Integration for quickstart.

  5. Selecciona una región para la integración.
  6. Haz clic en Crear para abrir el editor de integración.

Agrega y configura un activador de API

Se requieren activadores para iniciar la secuencia de tareas que conforman una integración. Se puede usar cualquier activador disponible para iniciar una integración. Para la guía de inicio rápido, usa el Activador de API.

Para configurar el activador de API, sigue estos pasos:

  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.
  3. Haz clic en el elemento Activador de API en el diseñador para abrir el panel de configuración del activador.
  4. La integración de Apigee propaga automáticamente la Etiqueta, el Nombre y el ID del activador. El ID del activador se genera a partir de máquinas y no puedes editar el valor. Sin embargo, puedes editar el valor de las propiedades Etiqueta y Nombre del activador.

    Los cambios en las propiedades se guardan automáticamente.

Agrega y configura tareas

Una tarea es un conjunto ejecutable de pasos que puede tomar variables como entradas y generar variables como resultados. Al igual que con los activadores, se puede usar cualquier tarea disponible en una integración. En esta guía de inicio rápido, se usan las tareas Llamar a extremo REST, Asignación de datos y Enviar correos electrónicos. Los detalles de configuración para cada tarea se describen en los pasos que se indican a continuación.

Configura la tarea Call REST Endpoint

Para configurar la tarea Llamar al extremo REST, haz lo siguiente:

  1. Selecciona Tareas para ver una lista de tareas disponibles.
  2. Haz clic y coloca el elemento Llamar a extremo de REST en el editor de integración.
  3. Agrega una conexión perimetral del elemento activador de API al elemento Llamar al extremo REST. Para ello, coloca el cursor sobre un punto de control en el elemento Activador de API, luego haz clic en una línea y arrástrala hasta un punto de control en el elemento de tarea Llamar al extremo REST. El perímetro denota el flujo de control del activador de API a la tarea Llamar al extremo REST.

    Un perímetro es una conexión entre dos elementos en una integración. La conexión denota la dirección del flujo de control de un elemento (tarea o activador) a otro. Para obtener más información sobre los perímetros, consulta Perímetros.

  4. Haz clic en el elemento Llamar a extremo de REST en el diseñador para abrir el panel de configuración de la tarea. Establece las siguientes propiedades:
    • Etiqueta: Ingresa un nombre personalizado para esta tarea. Por ejemplo, ingresa Call REST Endpoint Task.
    • Autenticación: Para esta guía de inicio rápido, no se requiere un perfil de autenticación. Para obtener más información sobre el uso de perfiles de autenticación para otros casos de uso, consulta Crea perfiles de autenticación en la integración de Apigee.
    • Entrada de tareas: Ingresa los detalles para llamar al extremo de REST. La información ingresada aquí se usa como entrada para la tarea Llamar al extremo REST. Ingresa la siguiente información:
      • URL base del extremo: ingresa https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031. Esta API pública de wikimedia.org muestra la cantidad de páginas vistas de un artículo denominado Árbol para un mes determinado.
      • Método HTTP: Selecciona GET mediante la lista del menú desplegable.
    • Salida de tareas:: Aquí la integración con Apigee propaga tres variables para contener el resultado de los datos de respuesta del llamado al extremo REST:
      • responseHeader(Llamar al extremo REST): Esta variable contiene los datos del encabezado de respuesta asociados con la tarea Llamar al extremo REST. Los datos variables son del tipo String (STR).
      • responseBody(Llamar al extremo REST): Esta variable contiene los datos del cuerpo de la respuesta asociados con la tarea Llamar al extremo REST. Los datos variables son del tipo String (STR).
      • responseStatus(Llamar al extremo REST): Esta variable contiene los datos de estado de la respuesta asociados con la tarea Llamar al extremo REST. Los datos variables son del tipo String (STR).
    • Para ver los detalles de cada variable, haz clic en el nombre de la variable en el panel de configuración de tareas. En esta guía de inicio rápido, deja los valores predeterminados para cada una de estas variables.
    • Los campos restantes deben contener los siguientes valores predeterminados:
      • Seguir los redireccionamientos: True
      • La tarea debería fallar en error de HTTP False
      • Estrategia de manejo de errores
        • Estrategia para ejecuciones síncronas: None
        • Estrategia para ejecuciones asíncronas: None

    Los cambios en las propiedades se guardan automáticamente.

Agrega y configura la tarea de asignación de datos

Para configurar la tarea de asignación de datos, haz lo siguiente:

  1. Selecciona Tareas para ver una lista de tareas disponibles.
  2. Haz clic y coloca el elemento Asignación de datos en el editor de integración.
  3. Agrega una conexión perimetral desde el elemento Llamar al extremo REST al elemento asignación de datos coloca el cursor sobre un punto de control en el elemento Llamar al extremo REST. Luego, haz clic en una línea y arrástrala hasta un punto de control en el elemento de tarea Asignación de datos. El borde denota el flujo de control de la tarea Llamar a extremo de REST a la tarea Asignación de datos.
  4. Haz clic en la tarea Asignación de datos en el diseñador para abrir el panel de configuración de la tarea.
  5. Haz clic en Abrir editor de asignación de datos.

    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. Si deseas obtener más detalles para pasar datos como variables, consulta Usa variables en la integración de Apigee.

    Para esta guía de inicio rápido, crea una asignación con el valor responseBody(Llamar al extremo REST) como entrada:

    1. Arrastra la variable responseBody del panel Variables a la primera fila de Entrada.
    2. Haz clic en + (Agregar una función) en el chip de variable responseBody para ver la lista desplegable de funciones disponibles.
    3. Puedes aplicar una serie de funciones para transformar los datos en la variable de entrada.

      En este caso, puedes convertir la carga útil en JSON y, luego, iterar sobre el array de respuestas para obtener la lista de nombres de productos necesarios en las notificaciones por correo electrónico.

      • Selecciona TO_JSON() para convertir la string responseBody en JSON.
      • Haz clic en + (Agregar una función) en el chip de la variable responseBody para seleccionar y encadenar la función GET_PROPERTY().
      • Para agregar el parámetro de entrada para GET_PROPERTY(), haz clic en Variable o Valor y, en Valor, ingresa items.

        Esta función extraerá una propiedad de la carga útil JSON. Pasa la propiedad items como parámetro para esta función. Esto mostrará una lista de SOLO los nombres de los productos, sin otra información sobre ellos. La función se debe leer de la siguiente manera: 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)
      • Si necesitas quitar o borrar una función, haz clic en el símbolo -.
    4. Haz clic en el primer campo de la columna Salida a fin de crear una variable nueva para conservar el valor de los datos transformados. Completa los siguientes campos:
      • Nombre: Ingresa JSONList.
      • Tipo de datos: JSON
      • Selecciona la casilla de verificación Usar como resultado de la integración.
      • Haz clic en Crear para crear la variable y cerrar el panel. La nueva variable JSONList aparecerá en la lista Variables del lado izquierdo del Editor de asignación de datos.
    5. Cierra el Editor de asignación de datos una vez que se complete la asignación. Los cambios se guardarán automáticamente.

Agrega y configura la tarea Enviar correo electrónico

Para configurar la tarea Enviar correo electrónico, haz lo siguiente:

  1. Selecciona Tareas en el editor de integración para ver la lista de tareas disponibles.
  2. Haz clic y coloca el elemento Enviar correo electrónico en el editor de integración.
  3. Agrega una conexión perimetral del elemento Asignación de datos al elemento de Enviar correo electrónico cuando colocas el cursor sobre un punto de control del elemento Asignación de datos, luego, haz clic en una línea y arrástrala hasta un punto de control en el elemento de tarea Enviar correo electrónico. El perímetro denota el flujo de control de la tarea de Asignación de datos a la tarea de Enviar correo electrónico.
  4. Haz clic en el elemento Enviar correo electrónico en el diseñador para abrir el panel de configuración de la tarea. Establezce las siguientes propiedades:
    • A los destinatarios: Ingresa tu dirección de correo electrónico. Usa este correo electrónico para confirmar que la integración se completó correctamente.
    • Asunto: Ingresa Email from Apigee Integration.
    • Cuerpo en texto sin formato: Selecciona la variable JSONList que creaste antes en la tarea Asignación de datos.
    • Las opciones restantes pueden dejarse en la configuración predeterminada.

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

Verifica las conexiones perimetrales necesarias

Verifica que hayas agregado una conexión perimetral entre los elementos en tu integración. La conexión denota la dirección del flujo de control de un elemento (tarea o activador) a otro. Para obtener más información sobre los perímetros, consulta Perímetros.

La conexión completa debería aparecer como se muestra en la siguiente figura:

Imagen que muestra el flujo de inicio rápido Imagen que muestra el flujo de inicio rápido

Prueba la integración

Para probar la nueva integración, sigue estos pasos:

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

    Aparecerá el cuadro de diálogo Probar integración.

  2. Haz clic en Probar integración.

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

Cuando la compilación se completa de forma correcta, la integración envía un correo electrónico con los valores JSON a la dirección de correo electrónico especificada en la tarea Enviar correo electrónico. Confirma la recepción del correo electrónico en tu cliente de correo electrónico.

El correo electrónico que envió la integración debe contener un cuerpo similar al siguiente: 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

Además de verificar el contenido del correo electrónico, puedes inspeccionar los registros para ver el estado y la carga útil de una integración determinada. Para ver los registros, haz lo siguiente:

  1. Haz clic en Registros en la barra de herramientas del editor de integración.
  2. En la página Registros de ejecución, puedes ver los detalles de cada intento para ejecutar una integración. Cada entrada incluye detalles para el intento de ejecución, incluidos los siguientes:
    • Nombre de la integración
    • ID de ejecución
    • Estado
    • Hora de inicio
    • Duration
    • Versión de la integración
    • ID de activador
  3. Haz clic en la flecha desplegable (>) junto a la integración ejecutada para ver una lista expandida de tareas y variables en la integración, junto con el estado de la tarea y las cargas útiles de la variable.