OTOBO / Znuny Web Services - REST API

Einleitung in die Integration externer Schnittstellen

In einer global vernetzten Welt müssen Ticketsysteme in der Lage sein, automatisiert auf Anfragen von anderen Systemen zu reagieren sowie Anfragen oder Daten an externe Dienste senden zu können. OTOBO, das leistungsstarke Open-Source-Ticketsystem, begegnet dieser Herausforderung mit seinem Generischen Interface. Es ermöglicht Administratoren, ohne tiefes Programmierwissen, Webdienste für vielfältige Aufgaben zu erstellen. OTOBO unterstützt die Kommunikation via REST- und SOAP-Protokoll, ermöglicht die nahtlose Integration mit:

• CRM-Systemen
• Projektmanagementsystemen
• Dokumentenmanagementsystemen
• und vielen weiteren Anwendungen

Ein Webdienst fungiert als Bindeglied zwischen OTOBO und externen Systemen. Dabei definieren Operationen und Invoker die Richtung der Kommunikation, während Mapping und Transport festlegen, wie Daten übertragen und interpretiert werden. Mit OTOBO können Sie Webdienste konfigurieren, um intern Aktionen auszuführen, Anfragen auf Remote-Systemen zu initiieren, Datenkonversionen zwischen den Systemen zu managen und das Kommunikationsprotokoll festzulegen.

Der Zugang zu den Web-Services ist im Modul Web Services der Gruppe Prozesse & Automation zu finden. Eine frische Installation von OTOBO enthält standardmäßig keine vorkonfigurierten Web-Services. Folgend illustriert die Dokumentation, wie Webdienste erstellt, bearbeitet, gelöscht, geklont, exportiert und importiert werden können, sowie den Einsatz des Debugger-Tools. Hierfür sei auf die Schritte verwiesen, die in der offiziellen OTOBO-Administrationsdokumentationdetailiert beschrieben sind.

Implementierung der Interfaces

Die Implementierung von Web-Services in OTOBO ermöglicht eine flexible und dynamische Integration Ihrer Geschäftsprozesse mit zahlreichen externen Tools und Systemen. Durch die Generierung und Nutzung dieser Services wird die Effizienz gesteigert, indem manuelle Eingriffe reduziert und die Antwortzeiten auf Klientenanfragen verkürzt werden. Darüber hinaus sorgt die Vielseitigkeit des generischen Interfaces dafür, dass OTOBO nahezu unbegrenzt erweiterbar ist und sich somit perfekt in bestehende IT-Landschaften einfügt.

Sicherheit und Konfiguration

Bezüglich der Konfiguration und Sicherheit von Webdiensten ist es wichtig zu beachten, dass bei einem Export alle gespeicherten Passwörter im Klartext mitexportiert werden. Die Aufbewahrung und der Umgang mit Passwörtern sollten daher mit besonderer Sorgfalt behandelt werden.

Für detaillierte Informationen zur systeminternen Konfiguration, wie zum Beispiel die Konfigurationsmöglichkeiten von Cache und Frontend-Modulen, empfehlen wir, das Dokument otobo-system-configuration.txt zu konsultieren. Diese Quelle bietet einen umfassenden Überblick über alle Konfigurationsoptionen.

Dokumentation dr Anbindungen

Webdienste bieten in einer zunehmend digitalisierten Betriebsumgebung die Möglichkeit, OTOBO mit anderen Systemen und Diensten zu verknüpfen. Das Gewährleisten einer effizienten und sicheren Kommunikation bedeutet daher, Webdiensteinstellungen im Vorfeld präzise zu konfigurieren. Im Folgenden werden die Grundlagen der Einstellungen für Webdienste in OTOBO detaillierter erläutert, um Ihnen eine umfassendere Handlungsanleitung zu bieten.

Allgemeine Schnittstellen EInstellungen

• Name*

  • Der Name identifiziert den Webdienst eindeutig innerhalb von OTOBO. Es ist wichtig, einen klaren und beschreibenden Namen zu wählen, der die Funktion oder den Partner reflektiert, mit dem interagiert wird.

• Beschreibung

  • Ein erweiterter Kommentar, der den Zweck und die Funktionalität des Webdienstes detailliert darstellt. Dies erleichtert die Übersichtlichkeit und Wartbarkeit.

• Remote-System

  • Ermöglicht es, den Namen des externen Systems festzulegen, mit dem OTOBO interagiert.

• Debug-Schwellenwert

  • Wählen Sie, wie ausführlich die Protokollierung der Kommunikation erfolgen soll. Die Einstellungen reichen von Debug (detaillierteste Protokollierung) bis zu Fehler (nur Fehlermeldungen).

• Gültigkeit

  • Bestimmt, ob der Webdienst aktiviert (gültig) oder deaktiviert (ungültig, vorübergehend ungültig) ist. Nur gültige Webdienste werden von OTOBO ausgeführt.

Netzwerktransport - SOAP oder REST

Für die Implementierung der Integration mit anderen Systemen bieten sich unterschiedliche Protokolle an. Hierbei ist die Wahl des Netzwerktransports grundlegend:

• Netzwerktransport

  • Wählen Sie zwischen HTTP::REST und HTTP::SOAP. Diese Protokolle definieren, wie die Datenübertragung zwischen dem OTOBO Ticketsystem und dem verbundenen System erfolgt.

• Operation hinzufügen

  • Ermöglicht es, spezifische Aktionen, sogenannte Operationen, für den Webdienst zu definieren. Hierbei können Sie aus einer Vielzahl von vordefinierten Operationen wählen, wie beispielsweise Ticket::TicketCreate zum Anlegen von Tickets.

Erstellung eines Tickets via REST

Ein praktisches Beispiel verdeutlicht den Wert von Webdiensten in OTOBO. Über das HTTP::REST-Protokoll lässt sich die Operation Ticket::TicketCreate einrichten. Die definierten Routen ermöglichen es externen Systemen, mithilfe von HTTP-POST-Requests Tickets in OTOBO zu erstellen. Hierdurch werden neue Dimensionen der Automatisierung und Integration realisiert, was Prozesseffizienz und Kundenzufriedenheit bedeutend steigern kann.

Webservices OTOBO AI Ticketklassifizierung(ATC)

Für die Nutzung der AI Ticketklassifizierung(ATC) in OTOBO, müssen Sie die Webdiensteinstellungen entsprechend konfigurieren. ATC benötigt Zugriff über die REST API um auf die Ticketdaten zuzugreifen und die Klassifizierung durchzuführen. OTOBO Ticket Klassifizierung

Sicherheitshinweis

Beachten Sie, dass bei Exporten der Webdiensteinstellungen Passwörter im Klartext exportiert werden können. Es ist daher essenziell, sensible Informationen geschützt zu behandeln und Sicherheitsbestimmungen zu beachten.

Die effektive Nutzung von Webdiensten in OTOBO ermöglicht es Unternehmen, ihre Arbeitsabläufe intelligenter und agiler zu gestalten. Durch die präzise Konfiguration der Webdiensteinstellungen wird eine solide Grundlage geschaffen, die es erlaubt, OTOBO nahtlos in das digitale Ökosystem eines Unternehmens zu integrieren. Webdiensteinstellungen und -operationen in OTOBO

Die Integration externer Systeme mit OTOBO über Webdienste ist ein essentieller Bestandteil, um ein effizientes Ticketmanagement zu gewährleisten. Diese Integration wird durch die Definition verschiedener Operationen ermöglicht, die spezifische Aktionen im Rahmen des Ticketlebenszyklus ausführen können. Ein wesentlicher Teil dieser Integration ist das Verständnis der notwendigen Attribute für jede Operation sowie die Verwendung des XLST-Standards für die Datenübertragung.

Erforderliche Attribute für die Schnittstellenoperationen

Für die grundlegenden Ticketoperationen in OTOBO werden spezifische Attribute benötigt. Hier sind Links zu den offiziellen Ressourcen, die die zur Erstellung, Abrufung, Aktualisierung, Suche und zum Abrufen der Historie von Tickets erforderlichen Attribute detailliert beschreiben:

• TicketCreate : TicketCreate Spezifikation
  • TicketGet : TicketGet Spezifikation
  • TicketUpdate : TicketUpdate Spezifikation
  • TicketSearch : TicketSearch Spezifikation
  • TicketHistoryGet : TicketHistoryGet Spezifikation

Diese Dokumentation ermöglicht es den Entwicklern, Anpassungen präzise durchzuführen und sicherzustellen, dass alle Anfragen die notwendigen Informationen enthalten, um erfolgreich bearbeitet zu werden.

Verwendung des XLST-Standards für die Datenübertragung

Die XLST-Transformation ist eine mächtige Technik, um eingehende Daten aus Webservice-Anfragen in eine für OTOBO verarbeitbare Form zu übertragen. Indem Sie bspw. ein dynamisches Feld "RemoteTicketID" für Tickets erstellen, können Sie eingehende Daten effizient speichern und weiterverarbeiten:

<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>

Dieses Beispiel zeigt, wie Sie den Wert des eingehenden Attributs incidentID in ein Ticket-Dynamikfeld namens RemoteTicketID transformieren können.

Webdiensteinstellungen: Anforderer (Requester)

Für die Implementierung von Webdiensteprozeduren als Anforderer bietet OTOBO die Auswahl zwischen den Protokollen HTTP:: REST und HTTP::SOAP. Hierbei ist die Auswahl des Netzwerktransports elementar, um eine ordnungsgemäße Verbindung mit dem externen System sicherzustellen. Nach Auswahl des Transports muss die Konfiguration gespeichert und entsprechend den spezifischen Anforderungen angepasst werden.

Die Errichtung eines Fehlerbehandlungsmoduls ist ebenso ein wichtiger Schritt, um eine robuste Kommunikation zu garantieren. OTOBO ermöglicht es, dafür spezifische Module zu implementieren und zu konfigurieren.

Abschluss und weiterführende Schritte

Indem OTOBO eine vielseitig konfigurierbare API für Webdienste bereitstellt, eröffnet es eine Welt der Möglichkeiten für die Integration und Automatisierung von Ticketmanagementprozessen. Durch die Bereitstellung genauer Spezifikationen und die Verwendung von Standards wie XLST für die Datenmanipulation bietet OTOBO seinen Nutzern eine flexible Basis für die Erweiterung ihrer Ticketingsysteme im Einklang mit ihren spezifischen Geschäftsanforderungen.

Egal ob als Anbieter oder Anforderer, die präzise Bearbeitung von Webdiensteinstellungen sichert eine nahtlose und effiziente Kommunikation mit externen Systemen und Diensten.

FAQs

Was sind die möglichen Protokolle, die OTOBO zur Kommunikation über Web-Services unterstützt?

OTOBO unterstützt die Kommunikation via REST- und SOAP-Protokoll.

Wo finden sich die Web-Services in OTOBO?

Der Zugang zu den Web-Services ist im Modul 'Web Services' der Gruppe 'Prozesse & Automation' im Admin Bereich zu finden.

Was ist ein wichtiger Aspekt bezüglich Sicherheit und Konfiguration von Webdiensten in OTOBO?

Bei einem Export der Webdiensteinstellungen werden alle gespeicherten Passwörter im Klartext mitexportiert, daher ist es wichtig, sensible Informationen geschützt zu behandeln und Sicherheitsbestimmungen zu beachten.

OTOBO Dienstleistungen

Wir bieten verschiedene Dienstleistungen rund um OTOBO an. Dazu gehören:

• OTOBO Beratung
• OTOBO Installation
• OTOBO Anpassungen
• OTOBO Schulungen
• OTOBO Support

Wenn du Interesse an unseren Dienstleistungen hast, dann schreib uns eine E-Mail an

tab@softoft.de

Oder erfahre mehr über unsere OTOBO Dienstleistungen