Skip to content

OTOBO / Znuny Servicios Web - API REST

Introducción a la integración de interfaces externas

INFO

Este artículo de servicio 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 solicitudes de otros sistemas y 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 conocimientos de programación profundos. OTOBO admite la comunicación a través de protocolos REST y SOAP, lo que permite una integración sin problemas con:

  • Sistemas de gestión de relaciones con los clientes
  • Sistemas de gestión de proyectos
  • Sistemas de gestión de documentos
  • Y muchas otras aplicaciones

Un servicio web actúa como enlace entre OTOBO y sistemas externos. Las Operaciones y Invoker definen la dirección de la comunicación, mientras que Mapping y Transporte establecen cómo se transfieren e interpretan los datos. Con OTOBO, puede configurar servicios web para realizar acciones internas, iniciar solicitudes en sistemas remotos, gestionar conversiones de datos entre sistemas y establecer 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 fresca de OTOBO no contiene servicios web preconfigurados de forma predeterminada. La documentación siguiente ilustra cómo se pueden crear, editar, eliminar, clonar, exportar e importar servicios web, así como el uso de la herramienta de depuración. Para ello, se remite a los pasos detallados en la documentación oficial de administración de OTOBO.

Implementación de interfaces

La implementación de servicios web en OTOBO permite una integración flexible y dinámica de sus procesos comerciales con numerosas herramientas y sistemas externos. Al generar y utilizar estos servicios, se mejora 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 casi ilimitadamente extensible y se adapte perfectamente a 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 exportan en texto plano. Por lo tanto, el almacenamiento y el 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 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 enlaces

Los servicios web ofrecen la posibilidad de vincular OTOBO con otros sistemas y servicios en un entorno de operación cada vez más digitalizado. Garantizar una comunicación eficiente y segura significa configurar los ajustes de los servicios web de forma precisa. A continuación, se explican detalladamente los fundamentos de la configuración de los servicios web en OTOBO para ofrecer una guía de acción más completa.

Ajustes de interfaz general

  • Nombre*

    • El nombre identifica el 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 establecer el nombre del sistema externo con el que OTOBO interactúa.
  • Umbral de depuración

    • Seleccione la cantidad de detalle con la que se debe registrar la comunicación. Los ajustes van desde Depuración (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 se ejecutan en OTOBO.

Transporte de red - SOAP o REST

Para implementar la integración con otros sistemas, se ofrecen diferentes protocolos. La elección del transporte de red es fundamental:

  • Transporte de red

    • Seleccione entre HTTP::REST y HTTP::SOAP. Estos protocolos definen cómo se transfiere la data entre el sistema de tickets OTOBO y el sistema conectado.
  • Agregar operación

    • Permite definir acciones específicas, llamadas operaciones, para el servicio web. Puede elegir entre una variedad 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 realiza nuevas dimensiones de automatización e integración, lo que puede aumentar significativamente la eficiencia del proceso y la satisfacción del cliente.

Servicios web OTOBO AI Clasificación de tickets (ATC)

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

Advertencia de seguridad

Tenga en cuenta que al exportar la configuración del servicio web, las contraseñas se pueden exportar en texto plano. Es esencial tratar la información sensible con protección y seguir las normas de seguridad.

El uso efectivo de los servicios web en OTOBO permite a las empresas diseñar sus flujos de trabajo de forma más inteligente y ágil. Al configurar los ajustes del servicio web de forma precisa, se crea una base sólida que permite integrar OTOBO sin problemas en el ecosistema digital de una empresa. Configuración 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 un administrador de tickets eficiente. Esta integración se logra mediante la definición de varias operaciones que pueden realizar acciones específicas en el ciclo de vida del ticket. Una parte fundamental de esta integración es comprender los atributos necesarios para cada operación, así como el uso del estándar XLST para la transferencia de datos.

Atributos necesarios para las operaciones de interfaz

Para las operaciones de ticket básicas en OTOBO, se necesitan atributos específicos. A continuación, se proporcionan enlaces a los recursos oficiales que describen en detalle los atributos necesarios para crear, recuperar, actualizar, buscar y recuperar el historial de tickets:

Esta documentación permite a los desarrolladores realizar ajustes de forma precisa 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 poderosa para transferir datos entrantes de solicitudes de servicios web a una forma procesable por OTOBO. Al crear, por ejemplo, un campo dinámico "RemoteTicketID" para tickets, puede almacenar y procesar datos entrantes de forma eficiente:

xml

<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 transformar el valor del atributo entrante incidentID en un campo dinámico de ticket llamado RemoteTicketID.

Configuración de servicios web: solicitante (Requester)

Para implementar procedimientos de servicios web como solicitante, OTOBO ofrece la selección entre los protocolos HTTP::REST y HTTP::SOAP. La elección del transporte de red es elemental para garantizar una conexión adecuada con el sistema externo. Después de seleccionar el transporte, la configuración debe guardarse y adaptarse según las necesidades específicas.

El establecimiento 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 este propósito.

Conclusión y pasos siguientes

Al proporcionar una API configurable para servicios web, OTOBO abre un mundo de posibilidades para la integración y automatización de procesos de administración de tickets. Al ofrecer 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 tickets según sus necesidades comerciales específicas.

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