Configurar la integración

Ahora que ha agregado la integración HTTP, configure su integración. Estos datos, junto con la configuración de acciones de servicio, constituyen la base para crear microaplicaciones útiles.

Agregar dispositivos de punto final de datos

Configure los dispositivos de punto final de datos para leer los datos relevantes en caché. Todos los datos que queremos mostrar al usuario (o con los que queremos desencadenar eventos o acciones) deben almacenarse en caché.

Para agregar un dispositivo de punto final de datos, siga estos pasos:

  1. Seleccione Carga de datos.

    Agregar nuevo dispositivo de punto final

  2. Introduzca el nombre del dispositivo de punto final y el URI del dispositivo de punto final.

  3. Configure el método de solicitud.

  4. (Opcional) Seleccione + AGREGAR PARÁMETROS y configure los parámetros PATH, QUERY O HEADER si es necesario.

    Nota:

    El tipo de datos seleccionado determina el formato de los atributos. El formato determina los campos en las microaplicaciones. Utilice etiquetas Mustache para hacer referencia a nombres de parámetros. Por ejemplo, .

  5. Seleccione Tipo de paginación.

    El tipo de paginación que debe seleccionar depende del estándar de la API de integración de la aplicación de destino. Consulte la documentación de la API de integración de aplicaciones de destino para ver qué método de paginación utiliza. La integración HTTP le permite seleccionar entre los siguientes métodos de paginación estándar.

    • Ninguno: No hay paginación definida.
    • Página: Establece el límite de devoluciones por página.

      Ejemplo: https://example.com?limit=100&page=3

    • Ajuste: Ofrece dos parámetros, ajuste y límite. Ajuste define el número de registros que se van a omitir; límite define el número de registros que se van a mostrar por página.

      Ejemplo: https://example.com?limit=100&offset=300

    • Enlace: Define el método de paginación para definir el siguiente enlace de página en el cuerpo.

      Ejemplo:

       {
       "data" […]
       "next": https://ejemplo.com?lpage=3
       }
      
    • Enlace de encabezado: Similar a la paginación de enlace, pero define la paginación basada en el encabezado de página de la URL.

      Ejemplo:

       Enlace: <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=15>; rel="next",
       <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=34>; rel="last"
      
    • Cursor: La paginación de cursor utiliza un identificador único para un registro específico que sirve de puntero al siguiente registro para consultar y devolver la página de resultados.

      Ejemplo: https://example.com?paginationToken=BFLMPSVZ

    • OData: Seleccione la versión de OData para realizar la paginación según los estándares OData.

      Establecer el tipo de paginación del dispositivo de punto final

  6. Seleccione Servicio de prueba para comprobar que el dispositivo de punto final está configurado correctamente.

    Si el resultado de la prueba es satisfactorio, continúe con el siguiente paso. Si recibe un mensaje de error, solucione el problema basándose en el mensaje de error que reciba.

Obtener estructura de datos

Ahora puede crear las tablas en la sección Obtener estructura de datos.

  1. Seleccione Generar tablas.
  2. Seleccione Desde API o Desde JSON:
    • Desde API: Recupera los datos automáticamente desde el punto final definido.
    • Desde JSON: Use “Desde JSON de muestra” para pegar la API si es necesario; por ejemplo, si tiene la respuesta pero no puede llamar a la API ahora. ( Opcional) Defina la ruta de acceso raíz si se requiere una ruta alternativa desde el dispositivo de punto final definido. La ruta de acceso raíz debe definirse en notación de puntero JSON.
  3. Seleccione Generar tablas.
  4. Para establecer la clave principal, seleccione el icono de lápiz de Modificar atributos y active la clave principal del atributo que se utilizará como clave principal (por ejemplo, ID). Es importante destacar que la columna de la clave principal no puede contener valores nulos. No cambie el tipo de datos a TIMESTAMP.

    Nota:

    Al crear una microaplicación e integración personalizada, siempre debe asignar una clave principal para habilitar la carga incremental correcta, en lugar de una sobrescritura completa al sincronizar los datos.

  5. (Optativo) Seleccione Agregar tabla, configure las propiedades de tabla adicionales, según lo requiera la aplicación de destino deseada, y haga clic en Guardar. A continuación, puede volver a cargar la estructura de tabla desde el dispositivo de punto final de API.

  6. Sincronización incremental

    Con Sincronización Incremental activada, puede establecer la sincronización. Es decir, descargar solo los registros que se hayan actualizado desde la última sincronización de datos en intervalos más frecuentes. Para ello, configure la frecuencia con la que desea que se ejecute la llamada a la API. Introduzca al menos un parámetro horario del servidor. Si se deja sin establecer una programación de sincronización, la sincronización se establece en manual.

    Los parámetros personalizados solo son necesarios si la aplicación de destino los requiere. Cuando sea necesario, consulte la documentación de integración de la aplicación de destino. Si crea una cadena personalizada para la sincronización, debe introducirla entre corchetes. Por ejemplo, [actualizado:] ‘AAAA-MM-DD HHmm’.

    Para obtener más información sobre la sincronización, consulte a continuación Establecer la sincronización de datos.

  7. Introduzca el nombre base de las tablas creadas en la sección Obtener estructura de datos y seleccione:
    • Desde API: Recupera los datos automáticamente desde el punto final definido.
    • Desde JSON de muestra: Use “Desde JSON de muestra” para pegar la API si es necesario; por ejemplo, si tiene la respuesta pero no puede llamar a la API ahora.

    Establecer sincronización

  8. Seleccione Agregar.

Su dispositivo de punto final de datos está asignado, y ahora puede configurar sus acciones de servicio.

Nota:

Después de configurar y agregar el dispositivo de punto final, la estructura de la tabla se bloquea. Si necesita reestructurarla, debe crear y configurar un nuevo dispositivo de punto final para carga de datos.

Agregar llamadas adicionales a API

Al configurar dispositivos de punto final de datos para la integración de aplicaciones, puede agregar dispositivos secundarios adicionales al dispositivo principal original para habilitar el encadenamiento de llamadas. Una vez que haya configurado los dispositivos de punto final de datos, puede agregar otros dispositivos asociados.

Siga estos pasos:

  1. Seleccione Modificar en el menú de integración al que quiere agregar una llamada secundaria.

    Menú de modificación de integración

    Se abrirá la página de integración.

  2. Seleccione Agregar llamada secundaria a API en el menú Dispositivo de punto final de datos que quiere agregar:

    Menú Agregar llamada secundaria a API

  3. Seleccione la tabla principal y defina el dispositivo de punto final tal y como hizo en los pasos de la sección anterior Carga de datos.

Al definir el método de solicitud, puede establecer la ruta a un valor estático o de columna. Ahora la cadena de llamadas a la API está asociada a la llamada principal a la API. Los dispositivos de punto final principales/secundarios que haya definido se muestran en la página Dispositivo de punto final de datos.

Nota:

Al crear integraciones, se recomienda cargar los datos desde un solo dispositivo de punto final, en lugar de varios. Siempre que sea posible, utilice llamadas por lotes, en lugar de llamadas de dispositivo de punto final individuales.

Combinar tablas

Al configurar llamadas API secundarias, puede combinar (opcionalmente) tablas secundarias con la tabla principal seleccionando una de las siguientes opciones:

Seleccione No combinar si no desea combinar las tablas principal y secundarias.

Seleccione Combinar como detalle para obtener todas las tareas y solicitudes del sistema de registro, junto con cada detalle de solicitud, y combinarlas, por ejemplo, si las tablas principal y secundaria son:

/request-list
{
“id”: 123,
“Título”: “Coche”,
“Rol”: “Pedido”,
“Categoría”: “Ventas”
}

Y:

/request-detail/123
{
“id”: 123,
“Título”: “Coche”,
“Desc”: “Descapotable”,
“Fecha”: “2020-01-01”
}

Al seleccionar Combinar como detalle, devuelve la siguiente tabla:

ID Título Rol Categoría Descripción Fecha
123 Coche Pedido Ventas Descapotable 2020-01-01

Seleccione Combinar como sublista para anexar cada tabla secundaria individualmente a la tabla principal.

Configuración de tablas

Puede reconfigurar las claves principales de las tablas sin establecer una nueva configuración. Para ello, elimine entradas de tabla individuales en la pantalla de la tabla, vuelva a sincronizar la tabla y seleccione la nueva clave principal.

Agregar acciones de servicio

Cuando haya configurado la integración HTTP, podrá configurar las acciones de servicio. Con las acciones de servicio, se configuran las acciones de reescritura en el sistema de registros de la integración de aplicaciones. Las acciones de servicio se configuran de manera similar a los dispositivos de punto final de datos anteriores. Dado que su integración de aplicaciones puede tener cualquier número de combinaciones personalizadas, adoptaremos un enfoque genérico para explicar cómo funcionan las acciones de servicio.

Para agregar acciones de servicio, siga estos pasos:

  1. Seleccione la integración que creó en Nombre de la aplicación.
  2. Seleccione Acciones de servicio y Agregar nueva acción de servicio.
  3. Asígnele un nombre de acción (como Obtener información de tíquet de JIRA) e introduzca la ruta al URI del dispositivo de punto final: (/rest/api/2/issue/)
  4. Configure el método de solicitud en función de los requisitos de la API de integración de aplicaciones.

    Nota:

    Utilice etiquetas Mustache para hacer referencia a nombres de parámetros. Por ejemplo, .

  5. Seleccione AGREGAR para guardar la acción de servicio. Ahora, puede agregar otras acciones de servicio si es necesario.

Método de solicitud de API

Ahora puede configurar el método de solicitud en función de los requisitos de la API de integración de aplicaciones con los siguientes componentes:

  • GET: Recuperar recursos del sistema de registro (SOR) de integración de aplicaciones sin modificar.
  • POST: Crear un nuevo recurso en el sistema de registro (SOR) de integración de aplicaciones.
  • PUT: Actualizar los recursos existentes en la integración de aplicaciones.
  • PATCH: Hacer una actualización parcial de un recurso.
  • DELETE: Eliminar un recurso.

Con los siguientes parámetros de API configurables:

  • Encabezado: Define los parámetros incluidos en el encabezado de solicitud, generalmente relacionados con la autorización.
  • Ruta: Define los parámetros en la ruta del dispositivo de punto final, antes de la cadena de consulta.
  • Consulta: Define los parámetros en la cadena de consulta del dispositivo de punto final.
  • Cuerpo: Define los parámetros incluidos en el cuerpo de la solicitud.

Actualización de datos después de la ejecución de la acción

(Opcional) Para asegurarse de que los datos están completamente sincronizados después de ejecutar la acción, puede configurar una actualización de datos para obtener los datos más recientes del sistema de registros de la aplicación de destino.

Para configurar la actualización de datos tras la ejecución, siga estos pasos:

  1. Seleccione el dispositivo de punto final de datos del que desea obtener el registro actualizado.
  2. (Opcional) Habilite Incluir dispositivos de punto final secundarios solamente si se requieren los dispositivos de punto final de datos secundarios para obtener el registro actualizado al detalle.
  3. (Opcional) Extienda el URI del dispositivo de punto final original si permite que la actualización obtenga un único registro. Por ejemplo, si el URI del dispositivo de punto final https://domain/api/items se actualiza a https://domain/api/items/itemId. El nuevo URI del dispositivo de punto final debe devolver la misma estructura de datos que el original; de lo contrario, el análisis de datos fallará.
  4. (Opcional) Extienda los parámetros de solicitud originales con Agregar parámetro adicional si permite el filtrado de un único registro.

Cuando haya terminado con la configuración, seleccione Guardar.

Verificar las entidades necesarias

Utilice Tabla para comprobar la lista actual de tablas almacenadas en la caché y los filtros que se aplican a dichas tablas.

Ahora ya puede establecer y ejecutar la primera sincronización de datos, a menos que necesite crear relaciones personalizadas. Para obtener más información, consulte Establecer sincronización de datos.

Crear relación personalizada

Utilice la página Relaciones para crear una conexión personalizada entre tablas en la integración. Puede usar esta función si tiene una serie de direcciones URL base y se requieren varias integraciones o si quiere crear una relación personalizada en la misma integración. Este es un caso de uso avanzado. Le recomendamos que se familiarice con la creación de microaplicaciones en una sola integración antes de empezar a asignar múltiples integraciones.

  1. En la página Administrar microaplicaciones, seleccione el menú situado junto a la integración para la que desea verificar entidades.
  2. Seleccione Modificar y, a continuación, Relaciones.
  3. Seleccione Agregar nueva relación.

    Se abrirá la página Agregar relación.

  4. Puede asignar la tabla principal a la tabla externa.
  5. Introduzca el alias que desee tener.

Ahora puede asignar y agregar columnas de referencia adicionales basadas en las claves principales que haya configurado en cada una de sus integraciones.

Importante:

Si elimina una tabla, se eliminan también todas las relaciones.

Establecer sincronización de datos

Extraiga datos de sus aplicaciones integradas y transfiéralos a la plataforma de microaplicaciones para compararlos con la caché. Como práctica recomendada, se hace una sincronización completa cada 24 horas, y se pueden configurar sincronizaciones incrementales cada cinco minutos.

  1. En la página Administrar microaplicaciones, seleccione el menú situado junto a la integración para la que desea establecer la sincronización.
  2. Seleccione Sincronización.

    Cómo configurar la sincronización de datos

  3. Establezca los valores de sincronización de datos Completa e Incremental.

    • Completa Descarta la caché local y extrae todos los datos del sistema de origen.

      Importante:

      Procesar una sincronización completa puede tardar mucho tiempo. Recomendamos ejecutar la sincronización completa por la noche o, generalmente, durante las horas fuera de servicio. Para cancelar una sincronización de datos en curso, seleccione el icono X.

    • Incremental Extrae solo los registros que han cambiado (nuevos y actualizados). No carga los datos eliminados.

      Importante:

      No todas las API admiten sincronización incremental.

      Al definir una sincronización diaria o semanal, esta se produce aleatoriamente dentro de la franja horaria seleccionada. Por ejemplo, al seleccionar una sincronización completa diaria 00-04, esta tendrá lugar a una hora seleccionada aleatoriamente durante dicho período.

  4. Seleccione Guardar.

Nota:

También puede seleccionar los iconos de flecha para ejecutar las integraciones cuando lo crea necesario.

Mostrar registros de integración

Utilice el Registro de integración para ver un historial de cambios clasificados por gravedad. Utilice esta opción para solucionar problemas con su integración. Por ejemplo, si observa que la sincronización ha fallado, compruebe los registros de integración para ver por qué. O, si no se muestran las tarjetas previstas, compruebe los registros de integración para ver si ha tenido lugar la sincronización.

Cómo encontrar registros de integración

  1. En la página Administrar microaplicaciones, seleccione el menú situado junto a la integración de la que desea ver los registros de integración.
  2. Seleccione Registros de integración.
  3. Revise las entradas y seleccione el menú para filtrar por errores si es necesario.

Exportar configuraciones de integración

Puede exportar sus configuraciones de integración. Se descartan todas las credenciales, lo que incluye contraseñas y detalles de los clientes. Solo se exporta la configuración almacenada en el servidor de microaplicaciones. Por ejemplo, la exportación mantiene su nombre de usuario, pero no su contraseña. Además. la exportación mantiene su configuración de OAuth, pero no el secreto del cliente.

  1. En la página Administrar microaplicaciones, seleccione el menú que aparece junto a la integración que quiere exportar.
  2. Seleccione Exportar configuración.

    Se descargará el archivo service.mapp.

Qué hacer a continuación

Ahora que ha creado y configurado su integración personalizada, puede crear sus propias microaplicaciones para ofrecer la mejor experiencia de usuario final, a fin de satisfacer sus necesidades y optimizar los flujos de trabajo diarios. Para obtener más información, consulte Personalizar microaplicaciones.