Znuny Web Services - REST API

Einführung in externe Schnittstellenintegration

INFO

Dieser Web Service Artikel hat eine große Überschneidung mit dem Artikel REST API REST API.

In einer weltweit vernetzten digitalen Umgebung müssen Ticketsysteme automatisiert auf Anfragen anderer Systeme reagieren und gleichzeitig Daten oder Anfragen an externe Dienste senden können. Znuny, das leistungsstarke Open-Source-Ticketsystem, adressiert diese Anforderung mit seinem Generic Interface. Es ermöglicht Administratoren, auch ohne umfassende Programmierkenntnisse, Webdienste für vielfältige Aufgaben zu konfigurieren. Znuny unterstützt die Kommunikation über REST- und SOAP-Protokolle und ermöglicht die nahtlose Integration mit:

• CRM-Systemen
• Projektmanagement-Tools
• Dokumentenmanagementsystemen
• und vielen weiteren Anwendungen

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

Der Zugang zu den Web-Services befindet sich im Modul Web Services der Gruppe Prozesse & Automation. Eine frische Installation von Znuny enthält standardmäßig keine vorkonfigurierten Web-Services. Die folgende Dokumentation illustriert, wie Webdienste erstellt, bearbeitet, gelöscht, geklont, exportiert und importiert werden können, sowie den Einsatz des Debugger-Tools.

Implementierung der Schnittstellen

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

Sicherheit und Konfiguration

Bei der Konfiguration und Sicherheit von Webdiensten ist 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 die offizielle Znuny-Systemkonfigurationsdokumentation zu konsultieren.

Dokumentation der Anbindungen

Webdienste bieten in einer zunehmend digitalisierten Betriebsumgebung die Möglichkeit, Znuny 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 Znuny detaillierter erläutert, um Ihnen eine umfassende Handlungsanleitung zu bieten.

Allgemeine Schnittstellen-Einstellungen

• Name*

  • Der Name identifiziert den Webdienst eindeutig innerhalb von Znuny. 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 Znuny 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 Znuny 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 Znuny 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 Znuny. Ü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 Znuny zu erstellen. Hierdurch werden neue Dimensionen der Automatisierung und Integration realisiert, was Prozesseffizienz und Kundenzufriedenheit bedeutend steigern kann.

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 Znuny 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, Znuny nahtlos in das digitale Ökosystem eines Unternehmens zu integrieren.

Webdiensteinstellungen und -operationen in Znuny

Die Integration externer Systeme mit Znuny ü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 von Standards für die Datenübertragung.

Erforderliche Attribute für die Schnittstellenoperationen

Für die grundlegenden Ticketoperationen in Znuny werden spezifische Attribute benötigt. Die wichtigsten Operationen umfassen:

• TicketCreate: Erstellt ein neues Ticket mit zugehörigem Artikel
• TicketGet: Ruft detaillierte Informationen zu einem oder mehreren Tickets ab
• TicketUpdate: Aktualisiert bestehende Ticket-Daten
• TicketSearch: Durchsucht Tickets anhand definierter Kriterien
• TicketHistoryGet: Ruft die Historie eines Tickets ab

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

Verwendung von XSLT für die Datenübertragung

Die XSLT-Transformation ist eine leistungsstarke Technik, um eingehende Daten aus Webservice-Anfragen in eine für Znuny verarbeitbare Form zu übertragen. Indem Sie beispielsweise 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: Requester (Anforderer)

Für die Implementierung von Webdienstprozeduren als Requester bietet Znuny 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 Einrichtung eines Fehlerbehandlungsmoduls ist ebenso ein wichtiger Schritt, um eine robuste Kommunikation zu garantieren. Znuny ermöglicht es, dafür spezifische Module zu implementieren und zu konfigurieren.

Zusammenfassung und weiterführende Schritte

Indem Znuny 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 XSLT für die Datenmanipulation bietet Znuny seinen Nutzern eine flexible Basis für die Erweiterung ihrer Ticketingsysteme im Einklang mit ihren spezifischen Geschäftsanforderungen.

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

---

Best Practices

• Authentifizierung sichern: Verwenden Sie immer HTTPS und API-Keys für Produktivumgebungen
• Fehlerbehandlung implementieren: Richten Sie dedizierte Error-Handler für kritische Operationen ein
• Logging aktivieren: Nutzen Sie Debug-Logging während der Entwicklung und deaktivieren Sie es in Produktion
• Versionierung: Dokumentieren Sie Änderungen an Webservice-Konfigurationen für bessere Nachvollziehbarkeit
• Testen: Testen Sie alle Operationen gründlich in einer Testumgebung, bevor Sie sie produktiv schalten

Mit einer sorgfältigen Konfiguration der Znuny Web Services schaffen Sie die Grundlage für eine erfolgreiche Integration in Ihre IT-Landschaft und profitieren von automatisierten, effizienten Geschäftsprozessen.