Servicios Web OTOBO / Znuny - API REST

Introducción a la Integración de Interfaces Externas

INFO

Este artículo sobre servicios web tiene una gran superposición con el artículo API REST API REST.

En un mundo globalmente conectado, los sistemas de tickets deben ser capaces de responder automáticamente a las solicitudes de otros sistemas, así como de enviar solicitudes o datos a servicios externos. OTOBO, el potente sistema de tickets de código abierto, aborda este desafío con su Interfaz Genérica. Permite a los administradores crear servicios web para diversas tareas sin necesidad de profundos conocimientos de programación. OTOBO soporta la comunicación a través de los protocolos REST y SOAP, permitiendo la integración perfecta con:

• Sistemas CRM
• Sistemas de gestión de proyectos
• Sistemas de gestión documental
• y muchas otras aplicaciones

Un servicio web actúa como un enlace entre OTOBO y sistemas externos. Las Operaciones y el Invoker definen la dirección de la comunicación, mientras que el Mapping y el Transport determinan cómo se transfieren e interpretan los datos. Con OTOBO, puede configurar servicios web para ejecutar acciones internamente, iniciar solicitudes en sistemas remotos, gestionar conversiones de datos entre sistemas y definir el protocolo de comunicación.

El acceso a los servicios web se encuentra en el módulo Servicios Web del grupo Procesos y Automatización. Una instalación nueva de OTOBO no contiene servicios web preconfigurados por defecto. A continuación, la documentación ilustra cómo crear, editar, eliminar, clonar e importar servicios web, así como el uso de la herramienta de depuración. Para ello, se hace referencia a los pasos descritos detalladamente en la documentación oficial de administración de OTOBO.

Implementación de las Interfaces

La implementación de servicios web en OTOBO permite una integración flexible y dinámica de sus procesos de negocio con numerosas herramientas y sistemas externos. Al generar y utilizar 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 de la interfaz genérica garantiza que OTOBO sea prácticamente ampliable de forma ilimitada, integrándose así perfectamente en los paisajes de TI existentes.

Seguridad y Configuración

En cuanto a la configuración y seguridad de los servicios web, es importante tener en cuenta que al exportar, todas las contraseñas almacenadas se exportarán en texto plano. Por lo tanto, el almacenamiento y manejo de 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 caché y módulos frontend, recomendamos consultar el documento otobo-system-configuration.txt. Esta fuente ofrece una visión completa de todas las opciones de configuración.

Documentación de las Conexiones

Los servicios web ofrecen, en un entorno operativo cada vez más digitalizado, la posibilidad de vincular OTOBO con otros sistemas y servicios. Garantizar una comunicación eficiente y segura significa, por lo tanto, configurar los ajustes de los servicios web de antemano de manera precisa. A continuación, se detallan los fundamentos de los ajustes para servicios web en OTOBO, con el fin de ofrecerle una guía de acción más completa.

Ajustes Generales de la Interfaz

• Nombre*

  • El nombre identifica de forma única el servicio web dentro de OTOBO. 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 ampliado que detalla el propósito y la funcionalidad del servicio web. Esto facilita la claridad y el mantenimiento.

• Sistema Remoto

  • Permite definir el nombre del sistema externo con el que interactúa OTOBO.

• Umbral de Depuración

  • Seleccione el nivel de detalle del registro de la comunicación. Los ajustes van desde Debug (registro más detallado) hasta Error (solo mensajes de error).

• Validez

  • Determina si el servicio web está activado (válido) o desactivado (inválido, temporalmente inválido). Solo los servicios web válidos son ejecutados por OTOBO.

Transporte de Red - SOAP o REST

Para la implementación de la integración con otros sistemas, se ofrecen diferentes protocolos. 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 OTOBO y el sistema conectado.

• Añadir Operación

  • Permite definir acciones específicas, denominadas operaciones, para el servicio web. Aquí puede elegir entre una variedad de operaciones predefinidas, como por ejemplo Ticket::TicketCreate para la creación de tickets.

Creación de un Ticket vía REST

Un ejemplo práctico ilustra el valor de los servicios web en OTOBO. 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 OTOBO mediante solicitudes HTTP POST. Esto permite nuevas dimensiones de automatización e integración, lo que puede aumentar significativamente la eficiencia de los procesos y la satisfacción del cliente.

Servicios Web OTOBO Clasificación de Tickets AI (ATC)

Para utilizar la Clasificación de Tickets AI (ATC) en OTOBO, debe configurar los ajustes de servicios web correspondientes. ATC necesita acceso a través de la API REST para acceder a los datos del ticket y realizar la clasificación. Clasificación de Tickets OTOBO

Nota de Seguridad

Tenga en cuenta que al exportar la configuración de servicios web, las contraseñas pueden exportarse en texto plano. Por lo tanto, es esencial tratar la información sensible con protección y cumplir las normativas de seguridad.

El uso eficaz de los servicios web en OTOBO permite a las empresas hacer que sus flujos de trabajo sean más inteligentes y ágiles. La configuración precisa de los ajustes de los servicios web crea una base sólida que permite integrar OTOBO sin problemas en el ecosistema digital de una empresa. Ajustes y Operaciones de Servicios Web en OTOBO

La integración de sistemas externos con OTOBO a través de servicios web es una parte esencial para garantizar una gestión de tickets eficiente. Esta integración se habilita mediante la definición de diversas operaciones que pueden realizar acciones específicas dentro del ciclo de vida del ticket. Una parte importante de esta integración es la comprensión de los atributos necesarios para cada operación y el uso del estándar XLST para la transferencia de datos.

Atributos Requeridos para las Operaciones de Interfaz

Para las operaciones básicas de tickets en OTOBO, se requieren atributos específicos. Aquí encontrará enlaces a los recursos oficiales que describen detalladamente los atributos necesarios para crear, recuperar, actualizar, buscar y obtener el historial de tickets:

• TicketCreate : Especificación TicketCreate
  • TicketGet : Especificación TicketGet
  • TicketUpdate : Especificación TicketUpdate
  • TicketSearch : Especificación TicketSearch
  • TicketHistoryGet : Especificación TicketHistoryGet

Esta documentación permite a los desarrolladores realizar ajustes precisos y garantizar que todas las solicitudes contengan la información necesaria para ser procesadas con éxito.

Uso del Estándar XLST para la Transferencia de Datos

La transformación XLST es una técnica potente para transferir datos entrantes de las solicitudes de servicios web a un formato procesable por OTOBO. Al crear, por ejemplo, un campo dinámico "RemoteTicketID" para tickets, puede almacenar y procesar eficientemente los datos entrantes:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:template match="/">
        <Ticket>
            <DynamicField>
                <Name>RemoteTicketID</Name>
                <Value>
                    <xsl:value-of select="incidentID"/>
                </Value>
            </DynamicField>
        </Ticket>
    </xsl:template>
</xsl:stylesheet>

Este ejemplo muestra cómo puede transformar el valor del atributo entrante incidentID en un campo dinámico de ticket llamado RemoteTicketID.

Ajustes de Servicios Web: Solicitante (Requester)

Para la implementación de procedimientos de servicios web como solicitante, OTOBO ofrece la opción entre los protocolos HTTP:: REST y HTTP::SOAP. La elección del transporte de red es fundamental para garantizar una conexión adecuada con el sistema externo. Después de seleccionar el transporte, la configuración debe guardarse y ajustarse según los requisitos específicos.

La creación de un módulo de manejo de errores es también un paso importante para garantizar una comunicación robusta. OTOBO permite implementar y configurar módulos específicos para ello.

Conclusión y Pasos Adicionales

Al proporcionar OTOBO una API de servicios web versátil y configurable, se 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 XLST para la manipulación de datos, OTOBO ofrece a sus usuarios una base flexible para ampliar sus sistemas de ticketing de acuerdo con sus requisitos de negocio específicos.

Ya sea como proveedor o solicitante, el procesamiento preciso de los ajustes de los servicios web garantiza una comunicación fluida y eficiente con sistemas y servicios externos.