OTOBO 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 mundo globalmente conectado, los sistemas de tickets deben ser capaces de reaccionar 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, afronta este desafío con su Generic Interface. Permite a los administradores, sin necesidad de conocimientos profundos de programación, crear servicios web para una amplia variedad de tareas. OTOBO admite la comunicación a través de los protocolos REST y SOAP, permitiendo una 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 los sistemas externos. En este proceso, las Operaciones y los Invokers definen la dirección de la comunicación, mientras que el Mapping y el Transport determinan cómo se transmiten 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 Web Services se encuentra en el módulo Web Services del grupo Procesos y Automatización. Una instalación nueva de OTOBO no contiene servicios web preconfigurados de forma predeterminada. A continuación, la documentación ilustra cómo se pueden crear, editar, eliminar, clonar, exportar e importar servicios web, así como el uso de la herramienta de depuración (debugger). 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. Mediante la generación y el uso de estos Services, 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 ilimitado en su capacidad de expansión, integrándose así perfectamente en los paisajes de TI existentes.

Seguridad y configuración

Con respecto a la configuración y seguridad de los servicios web, es importante tener en cuenta que, al realizar una exportación, todas las contraseñas guardadas se exportan en texto plano. Por lo tanto, el almacenamiento y manejo de contraseñas debe 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 de Frontend, recomendamos consultar el documento otobo-system-configuration.txt. Esta fuente ofrece una visión general 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 tanto, configurar con precisión los ajustes de los servicios web de antemano. A continuación, se explican con más detalle los fundamentos de los ajustes para servicios web en OTOBO para ofrecerle una guía de actuación más completa.

Ajustes generales de la interfaz

Nombre*
- El nombre identifica al servicio web de forma única 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 extendido 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 (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 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, existen diferentes protocolos disponibles. En este sentido, 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, llamadas operaciones, para el servicio web. 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 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 alcanzar nuevas dimensiones de automatización e integración, lo que puede aumentar significativamente la eficiencia de los procesos y la satisfacción del cliente.

Web Services OTOBO AI Ticket Classification (ATC)

Para utilizar la clasificación de tickets por IA (ATC) en OTOBO, debe configurar los ajustes de los servicios web en consecuencia. ATC requiere acceso a través de la REST API para acceder a los datos de los tickets y realizar la clasificación. Clasificación de tickets de OTOBO

Aviso de seguridad

Tenga en cuenta que, al exportar los ajustes de los servicios web, 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 servicios web en OTOBO 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 servicios web, se 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 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 fundamental de esta integración es la comprensión de los atributos necesarios para cada operación, así como el uso del estándar XSLT 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í hay 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 de TicketCreate
- TicketGet : Especificación de TicketGet
- TicketUpdate : Especificación de TicketUpdate
- TicketSearch : Especificación de TicketSearch
- TicketHistoryGet : Especificación de TicketHistoryGet

Esta documentación permite 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 del estándar XSLT para la transferencia de datos

La transformación XSLT es una técnica poderosa para convertir datos entrantes de solicitudes de servicios web en una forma procesable por OTOBO. Al crear, por ejemplo, un campo dinámico “RemoteTicketID” para tickets, puede guardar y procesar datos entrantes de manera eficiente:

<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 selección entre los protocolos HTTP::REST y HTTP::SOAP. En este caso, 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.

El establecimiento de un módulo de gestión de errores es también un paso importante para garantizar una comunicación robusta. OTOBO permite implementar y configurar módulos específicos para este fin.

Conclusión y pasos siguientes

Al proporcionar una API versátil y configurable para servicios web, OTOBO abre un mundo de posibilidades para la integración y automatización de los procesos de gestión de tickets. Mediante la provisión de especificaciones precisas y el uso de estándares como XSLT para la manipulación de datos, OTOBO ofrece a sus usuarios una base flexible para la expansión de sus sistemas de tickets de acuerdo con sus requisitos comerciales específicos.

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