Eine REST API ist eine sichere Methode, um Kanäle und Anwendungen in Ihren Zammad Helpdesk zu integrieren. Wir bieten einen einfachen Weg, indem wir JSON (JavaScript Object Notation) als Datenformat verwenden. Es gewährleistet einen effizienten und zuverlässigen Datenaustausch zwischen beiden Quellen und ermöglicht es Ihnen, Ihren Helpdesk mit eigenen Integrationen maßgeschneidert zu gestalten.
Bei Zammad gilt "API First". Das bedeutet, dass man mit der REST API alles machen kann, was auch über die Oberfläche geht. So haben Sie nie mehr fehlende, unvollständige oder veraltete API-Schnittstellen. (Und noch ein Fun Fact am Rande: Die Oberfläche ist selbst nur ein in JavaScript geschriebener API-Client, der im Browser läuft.)
Zammads REST/JSON-API unterstützt drei verschiedene Authentifizierungsmethoden:
- HTTP-Basis-Authentifizierung (Benutzername/Passwort)
- HTTP Token-Authentifizierung (Zugriffs-Token)
- OAuth2 (Token-Zugriff)
Es gibt spezielle API Token, die es ermöglichen, Zugriffsrechte weiter einzuschränken. Somit wird die Angriffsoberfläche und das Schadensausmaß minimiert, wenn ein Token doch mal in die falschen Hände geraten sollte.
Request-Format
In Bezug auf das Anfrageformat verwendet Zammad JSON für seine API, daher müssen Sie in jedem HTTP-Aufruf einen "Content-Type: application/json" setzen. Andernfalls wird die Antwort text/html sein. Auf diese Weise können Sie CURL-Anfragen durchführen, z. B. für Tickets und Benutzer.
Es ist auch möglich, eine Impersonation durchzuführen, also eine Anfrage im Namen eines anderen Benutzers durchzuführen. Wenn Sie eine eigene Anwendung haben und ein Ticket für den Kunden erstellen wollen (ohne die Information, dass der API-Benutzer dieses Ticket erstellt hat), dann können Sie den Zielbenutzer mit der Anfrage transferieren, um das Ticket im Namen des Kundenbenutzers zu erstellen.
Response-Format
Wenn eine Antwort erfolgreich ist, wird ein HTTP-Statuscode im Bereich 200 oder 300 zurückgegeben. Wenn ein Element erstellt oder aktualisiert wurde, werden alle neuen Attribute zurückgegeben (einschließlich serverseitig generierter Attribute wie created_at und updated_at).
API Clients
Es gibt zwei offizielle API Clients (PHP und Ruby), sowie verschiedene Community-gepflegte Clients, die eine noch einfachere Nutzung der API ermöglichen.
Alle Ressourcen unterstützen die Paginierung.
Mehr Informationen zur REST API sowie Details zur Nutzung finden Sie in unserer Admin Dokumentation.