Znuny Web Services - REST API

Introducción a la integración de interfaces externas

::: info Este artículo sobre Web Services tiene una gran superposición con el artículo REST API REST API. ::: En un entorno digital interconectado a nivel mundial, los sistemas de tickets deben reaccionar automáticamente a las solicitudes de otros sistemas y, al mismo tiempo, poder enviar datos o solicitudes a servicios externos. Znuny, el potente sistema de tickets de código abierto, aborda este requisito con su Generic Interface. Permite a los administradores, incluso sin amplios conocimientos de programación, configurar servicios web para diversas tareas. Znuny admite la comunicación a través de protocolos REST y SOAP y permite una integración perfecta con:

Sistemas CRM
Herramientas de gestión de proyectos
Sistemas de gestión documental
y muchas otras aplicaciones Un Web Service actúa como un puente entre Znuny y los sistemas externos. En este proceso, las Operationen (operaciones) y los Invoker (invocadores) definen la dirección de la comunicación, mientras que el Mapping (mapeo) y el Transport (transporte) determinan cómo se transmiten e interpretan los datos. Con Znuny, puede configurar Web Services para ejecutar acciones internamente, iniciar solicitudes en sistemas remotos, gestionar conversiones de datos entre sistemas y determinar el protocolo de comunicación. El acceso a los Web Services se encuentra en el módulo Web Services del grupo Procesos y Automatización. Una instalación nueva de Znuny no contiene Web Services preconfigurados de forma predeterminada. La siguiente documentación ilustra cómo se pueden crear, editar, eliminar, clonar, exportar e importar Web Services, así como el uso de la herramienta de depuración (Debugger).

Implementación de las interfaces

La implementación de Web Services en Znuny permite una integración flexible y dinámica de sus procesos de negocio con numerosas herramientas y sistemas externos. Mediante la creación y el uso de estos servicios, se aumenta la eficiencia al reducir las intervenciones manuales y acortar los tiempos de respuesta a las solicitudes de los clientes. Además, la versatilidad del Generic Interface garantiza que Znuny sea prácticamente ilimitado en su capacidad de expansión y, por lo tanto, se integre perfectamente en los paisajes de TI existentes.

Seguridad y configuración

Al configurar y asegurar los Web Services, debe tenerse en cuenta que, al realizar una exportación, todas las contraseñas guardadas se exportan en texto plano. Por lo tanto, el almacenamiento y el manejo de las contraseñas deben tratarse con especial cuidado. Para obtener información detallada sobre la configuración interna del sistema, como las opciones de configuración de Cache y los módulos de Frontend, recomendamos consultar la documentación oficial de configuración del sistema de Znuny.

Documentación de las conexiones

En un entorno operativo cada vez más digitalizado, los Web Services ofrecen la posibilidad de vincular Znuny con otros sistemas y servicios. Garantizar una comunicación eficiente y segura significa, por tanto, configurar con precisión los ajustes de los Web Services de antemano. A continuación, se explican con más detalle los fundamentos de los ajustes para los Web Services en Znuny, con el fin de ofrecerle una guía de actuación completa.

Ajustes generales de la interfaz

Nombre*
- El nombre identifica al Web Service de forma única dentro de Znuny. Es importante elegir un nombre claro y descriptivo que refleje la función o el socio con el que se interactúa.
Descripción
- Un comentario extendido que detalla el propósito y la funcionalidad del Web Service. Esto facilita la claridad y el mantenimiento.
Sistema remoto
- Permite definir el nombre del sistema externo con el que interactúa Znuny.
Umbral de depuración (Debug)
- Elija el nivel de detalle con el que debe realizarse el registro de la comunicación. Los ajustes van desde Debug (registro más detallado) hasta Error (solo mensajes de error).
Validez
- Determina si el Web Service está activado (válido) o desactivado (inválido, temporalmente inválido). Solo los Web Services válidos son ejecutados por Znuny.

Transporte de red - SOAP o REST

Para implementar la integración con otros sistemas, existen diferentes protocolos disponibles. Aquí, la elección del transporte de red es fundamental:

Transporte de red
- Elija entre HTTP::REST y HTTP::SOAP. Estos protocolos definen cómo se realiza la transferencia de datos entre el sistema de tickets Znuny y el sistema conectado.
Añadir operación
- Permite definir acciones específicas, llamadas operaciones, para el Web Service. Aquí puede elegir entre una multitud de operaciones predefinidas, como Ticket::TicketCreate para crear tickets.

Creación de un ticket vía REST

Un ejemplo práctico ilustra el valor de los Web Services en Znuny. A través del protocolo HTTP::REST, se puede configurar la operación Ticket::TicketCreate. Las rutas definidas permiten a los sistemas externos crear tickets en Znuny mediante solicitudes HTTP-POST. Esto permite realizar nuevas dimensiones de automatización e integración, lo que puede aumentar significativamente la eficiencia de los procesos y la satisfacción del cliente.

Nota de seguridad

Tenga en cuenta que, al exportar los ajustes de los Web Services, las contraseñas pueden exportarse en texto plano. Por lo tanto, es esencial tratar la información sensible de forma protegida y cumplir con las normas de seguridad. El uso efectivo de los Web Services en Znuny permite a las empresas hacer que sus flujos de trabajo sean más inteligentes y ágiles. Mediante la configuración precisa de los ajustes de los Web Services, se crea una base sólida que permite integrar Znuny sin problemas en el ecosistema digital de una empresa.

Ajustes y operaciones de Web Services en Znuny

La integración de sistemas externos con Znuny a través de Web Services es un componente esencial para garantizar una gestión de tickets eficiente. Esta integración se hace posible mediante la definición de diversas operaciones que pueden ejecutar acciones específicas dentro del ciclo de vida del ticket. Una parte esencial de esta integración es la comprensión de los atributos necesarios para cada operación, así como el uso de estándares para la transferencia de datos.

Atributos necesarios para las operaciones de interfaz

Para las operaciones básicas de tickets en Znuny, se requieren atributos específicos. Las operaciones más importantes incluyen:

TicketCreate: Crea un nuevo ticket con su artículo correspondiente
TicketGet: Recupera información detallada sobre uno o varios tickets
TicketUpdate: Actualiza los datos de tickets existentes
TicketSearch: Busca tickets según criterios definidos
TicketHistoryGet: Recupera el historial de un ticket Estas operaciones permiten a los desarrolladores realizar ajustes con precisión y garantizar que todas las solicitudes contengan la información necesaria para ser procesadas con éxito.

Uso de XSLT para la transferencia de datos

La transformación XSLT es una técnica potente para transferir datos entrantes de solicitudes de Web Services a una forma procesable por Znuny. Por ejemplo, al crear un campo dinámico “RemoteTicketID” para los tickets, puede guardar y procesar eficientemente los datos entrantes: Operationen Este ejemplo muestra cómo puede transformar el valor del atributo entrante incidentID en un campo dinámico de ticket llamado RemoteTicketID.

Ajustes de Web Services: Requester (Solicitante)

Para la implementación de procedimientos de Web Services como Requester, Znuny ofrece la elección entre los protocolos HTTP::REST y HTTP::SOAP. Aquí, la selección del transporte de red es elemental para garantizar una conexión adecuada con el sistema externo. Tras seleccionar el transporte, la configuración debe guardarse y adaptarse según los requisitos específicos. La configuración de un módulo de gestión de errores es también un paso importante para garantizar una comunicación robusta. Znuny permite implementar y configurar módulos específicos para ello.

Resumen y pasos siguientes

Al proporcionar una API versátil y configurable para Web Services, Znuny abre un mundo de posibilidades para la integración y automatización de los procesos de gestión de tickets. Al proporcionar especificaciones precisas y utilizar estándares como XSLT para la manipulación de datos, Znuny ofrece a sus usuarios una base flexible para la expansión de sus sistemas de ticketing de acuerdo con sus necesidades comerciales específicas. Ya sea como proveedor o como solicitante, el procesamiento preciso de los ajustes de los Web Services garantiza una comunicación fluida y eficiente con sistemas y servicios externos.

Best Practices

Asegurar la autenticación: Utilice siempre HTTPS y API-Keys para entornos de producción
Implementar gestión de errores: Configure manejadores de errores dedicados para operaciones críticas
Activar el registro (Logging): Utilice el registro de depuración durante el desarrollo y desactívelo en producción
Versionado: Documente los cambios en las configuraciones de los Web Services para una mejor trazabilidad
Pruebas: Pruebe todas las operaciones minuciosamente en un entorno de pruebas antes de ponerlas en producción Con una configuración cuidadosa de los Znuny Web Services, usted crea la base para una integración exitosa en su paisaje de TI y se beneficia de procesos de negocio automatizados y eficientes.