Conectores personalizados

Agregue sus propias conexiones y acciones a los flujos de trabajo con los sistemas empresariales y los servicios de terceros existentes. Los conectores personalizados utilizan las REST API para la comunicación y la herramienta de desarrollo de API Postman para crear solicitudes estándar.

Automatice sus servicios internos con los conectores personalizados

Si el servicio admite las REST API y los tipos de contenido JSON, puede utilizarlo en sus flujos de trabajo con los conectores personalizados.

Postman para crear REST API estándar

Workspace ONE Intelligence usa Postman para estandarizar las REST API que utiliza el sistema para conectarse y actuar con los servicios internos y de terceros. Crea acciones con una interfaz de plantilla de REST conocida que permite volver a utilizar las acciones guardadas. La versión gratuita de Postman tiene las funciones necesarias para crear recopilaciones para los conectores personalizados.

Pasos para usar los conectores personalizados

1. Cree una colección con solicitudes en Postman y expórtela.
2. Agregue una conexión personalizada en Workspace ONE Intelligence e importe las solicitudes . Estas solicitudes ahora están disponibles como acciones que puede utilizar en los flujos de trabajo.
3. Configure un flujo de trabajo con acciones importadas para automatizar una tarea mediante la conexión personalizada en Workspace ONE Intelligence .

Acciones para los conectores personalizados

Puede editar, eliminar y probar los conectores personalizados en Workspace ONE Intelligence. Puede usar acciones en varios conectores, así que tenga en cuenta las consecuencias de la edición o de la eliminación antes de actuar.

• Eliminar: para eliminar una conexión completa y todas sus acciones, debe en primer lugar retirarle la autorización. Una vez retirada la autorización, se desactivará cualquier flujo de trabajo que utilice una acción asociada con esta conexión. Una vez que el sistema elimina la conexión, elimina todas las acciones asociadas en otros flujos de trabajo. Debe editar y volver a activar los flujos de trabajo desactivados para volver a ejecutarlos. Esta acción no es reversible.
• Editar: puede editar el nombre de la conexión, la descripción y los tipos de autenticación en cualquier momento. Para editar los detalles de la solicitud de acción, edite la recopilación de Postman y, a continuación, vuelva a importarla en la conexión personalizada. Aviso: Si se editan los tipos de autenticación y se introducen las credenciales de forma incorrecta, las acciones no se podrán ejecutar. Edite estos datos con precaución.
• Probar: pruebe los conectores personalizados en Workspace ONE Intelligence para asegurarse de que Workspace ONE Intelligence y el servicio puedan comunicarse.

Registrar un conector personalizado

Para agregar una conexión personalizada, importe su recopilación de Postman. Las solicitudes en el archivo JSON de Postman son las acciones. Después de importar la recopilación, las acciones están disponibles para su uso en los flujos de trabajo.

Requisitos previos

• Cree una recopilación mediante el proceso que se describe en Usar Postman para conectores personalizados.
• El servicio que desee conectar debe admitir los tipos de contenido JSON y REST API.
• Workspace ONE Intelligence necesita acceder a los endpoints de API. Si los servicios están detrás de un firewall, utilice Unified Access Gateway como proxy inverso.
• Si usa OAuth2 para la autenticación, configure los detalles de autorización para que Workspace ONE Intelligence pueda recuperar, actualizar y acceder a los tokens del servicio.
  • URL de token de OAuth2
  • Secreto del Client
  • ID de cliente
  • Tipo de concesión (credenciales de cliente o contraseña)

Procedimiento

1. En Workspace ONE Intelligence, vaya a Integraciones > Conectores de flujo de trabajo y seleccione Agregar conector personalizado.
2. En Nombre del conector, introduzca un nombre que pueda identificarse para la conexión.
3. Para URL base, introduzca la URL del servicio de modo que Workspace ONE Intelligence pueda autenticarse. La URL del servicio y la URL de la conexión personalizada deben coincidir.
4. En Tipo de autenticación, seleccione el tipo de autenticación que se utilizará para acceder al servicio. Workspace ONE Intelligence reemplaza los encabezados de autenticación de Postman en las recopilaciones con este ajuste. Si el servicio utiliza un tipo de autenticación único basado en encabezado, agregue el encabezado a todas sus solicitudes en la recopilación de Postman y configure la URL base. En este caso, Workspace ONE Intelligence utiliza los encabezados configurados en la recopilación de Postman. Los ejemplos de tipos de autenticación basados en encabezados utilizan una clave de API o un token.
   • Autenticación básica: permite acceder a Workspace ONE Intelligence mediante la introducción de las credenciales.
   • Autenticación de OAuth2: introduzca los detalles para que Workspace ONE Intelligence pueda recuperar, actualizar y acceder a los tokens del servicio.
   • Sin autenticación: si no desea que Workspace ONE Intelligence invalide los encabezados de autenticación, seleccione este elemento de menú.
5. Para importar el archivo JSON de Postman, utilice el vínculo selecciónelo en su equipo situado en la parte central de la interfaz de usuario. La interfaz de usuario muestra la recopilación con sus solicitudes. Estas solicitudes de Postman ahora están disponibles como acciones para flujos de trabajo .
6. En la lista de acciones importadas, puede probar, editar y eliminar la acción.
   • Eliminar: si una acción que desea eliminar se utiliza en otros flujos de trabajo, el sistema desactiva esos flujos de trabajo y elimina la acción. Debe editar y volver a habilitar esos flujos de trabajo para permitir que continúen funcionando. La eliminación no es reversible.
   • Editar: puede editar los nombres y las descripciones de las acciones. El sistema recopila los nombres y las descripciones del JSON del Postman importado. Para editar los detalles de la solicitud de acción, edite la recopilación de Postman y, a continuación, vuelva a importarla en la conexión personalizada.
   • Probar: use el elemento de menú Probar para garantizar que la conexión funciona. El sistema prueba la solicitud configurada en la colección de Postman.

Usar Postman para los conectores personalizados

Use la aplicación Postman para crear las REST API estándar para los conectores personalizados. Este contenido ofrece un flujo de trabajo general para crear y exportar recopilaciones de Postman como archivos JSON.

La versión gratuita de la aplicación tiene las funciones para crear colecciones con solicitudes y exportarlas para flujos de trabajo .

Este tema sirve como descripción general de lo que se debe hacer para crear y exportar una recopilación. Su finalidad es servir como referencia. Consulte el centro de formación de Postman para obtener las instrucciones más recientes sobre cómo configurar el producto Postman.

Obtenga la aplicación Postman en la dirección https://www.getpostman.com.

Procedimiento

1. Agregue una recopilación.
2. Agregue y configure las solicitudes en la recopilación.
   • El nombre y la descripción proporcionados en estas solicitudes se utilizan en las acciones de flujo de trabajo en Workspace ONE Intelligence. Puede cambiarlos más tarde dentro de Workspace ONE Intelligence. A continuación, se muestra un ejemplo de una entrada en una solicitud de Postman y cómo se procesa como una acción en los flujos de trabajo de Workspace ONE Intelligence.
     
   • Considere la posibilidad de añadir encabezados tales como Content-Type: application/json. Si no agrega encabezados como el tipo de contenido JSON, las API pueden usar XML de forma predeterminada y XML no es compatible con los conectores personalizados.
   • Agregue los encabezados personalizados requeridos por su API a todas las solicitudes de la recopilación de Postman. Algunos ejemplos de encabezados personalizados serían los tipos de autenticación únicos basados en encabezados, tales como una clave de API o un token. Workspace ONE Intelligence retiene todos los encabezados excepto los encabezados de autenticación. Reemplaza los encabezados de autenticación con las configuraciones de Tipo de autenticación en la recopilación personalizada. Si Workspace ONE Intelligence reemplaza el encabezado de autenticación, el sistema seguirá enviando su autenticación única basada en encabezado para su uso, ya que la habrá agregado a otras solicitudes.
3. Envíe la solicitud para validarla. La validación generará la respuesta.
4. Guarde la respuesta como un ejemplo para la documentación. El protocolo Open API requiere este paso.
5. Guarde la solicitud.
6. Agregue más solicitudes según sea necesario.
7. Exporte la colección como Collection v2.1.