Wie funktioniert die Zendesk Upload Attachment API und wie wird sie verwendet?
- Grundlagen der Zendesk Upload Attachment API
- Technische Details und Authentifizierung
- Ablauf des Uploads und Einbindung in Tickets
- Einschränkungen und wichtige Hinweise
- Fazit
Die Zendesk Upload Attachment API ist eine Schnittstelle, die es Entwicklern ermöglicht, Dateien direkt in Zendesk hochzuladen und diese anschließend in Tickets, Kommentaren oder anderen Zendesk-Objekten zu verwenden. Dies ist besonders nützlich, wenn man Anhänge in Support-Tickets integrieren möchte, ohne die Benutzeroberfläche von Zendesk manuell zu nutzen. Im Folgenden wird die Funktionsweise der API sowie deren Anwendung ausführlich erklärt.
Grundlagen der Zendesk Upload Attachment API
Die Upload Attachment API von Zendesk ist dafür konzipiert, multipart/form-data Anfragen zu empfangen, mit denen Dateien an den Zendesk-Server übertragen werden. Diese API ermöglicht das Hochladen von Dateianhängen, die danach über eine eindeutige Upload-ID oder einen Token referenziert werden können, um sie in Tickets oder Kommentaren anzuhängen. Wichtig ist, dass der Upload zunächst als eigenständiger Schritt erfolgt, bevor die Datei endgültig in einem Zendesk-Ticket eingebunden wird.
Technische Details und Authentifizierung
Um die Upload Attachment API verwenden zu können, ist eine Authentifizierung erforderlich. Zendesk unterstützt üblicherweise die Basic-Authentifizierung mit Benutzername und API-Token oder OAuth. Die Anfragen an die API erfolgen per HTTPS an eine URL, die sich aus der Zendesk-Domain und dem Endpunkt /api/v2/uploads zusammensetzt. Beispielsweise lautet der Upload-Endpunkt:
https://{subdomain}.zendesk.com/api/v2/uploads.json?filename={dateiname}
Hier ist {subdomain} durch den eigenen Zendesk-Account zu ersetzen, und {dateiname} ist der Name der hochzuladenden Datei. Der HTTP-Methodentyp ist POST, und die Datei wird im Request-Body als multipart/form-data übergeben.
Ablauf des Uploads und Einbindung in Tickets
Der typische Ablauf beginnt damit, dass die Datei per POST an den Upload-Endpunkt geschickt wird. Die API antwortet mit einem Upload-Token oder einer Upload-ID, die als Referenz dient. Anschließend kann dieser Token verwendet werden, um beim Erstellen oder Aktualisieren eines Tickets den Anhang zuzuordnen. Dies geschieht über die Tickets-API, indem im JSON-Body das Feld uploads mit dem Upload-Token befüllt wird.
Beispielsweise beim Erstellen eines Tickets wird im Payload angegeben, welche Anhänge vorhanden sind, z.B.:
{ "ticket": { "comment": { "body": "Hier ist der Anhang", "uploads": } }
Dadurch wird die zuvor hochgeladene Datei im Ticket-Kommentar eingebunden und für Endnutzer sichtbar.
Einschränkungen und wichtige Hinweise
Die Zendesk Upload Attachment API beschränkt die maximale Dateigröße je nach Zendesk-Plan und -Einstellungen. Es gibt auch Beschränkungen bezüglich des erlaubten Dateityps aus Sicherheitsgründen. Außerdem ist zu beachten, dass die Uploads nur eine begrenzte Zeit gültig sind und nach Ablauf getrennt von Tickets gelöscht werden können, wenn sie nicht angehängt wurden. Daher sollte der Upload zeitnah im Zusammenhang mit einem Ticket erfolgen.
Fazit
Die Zendesk Upload Attachment API ist ein mächtiges Werkzeug zur Automatisierung und Integration von Dateianhängen in Zendesk Tickets. Durch das separate Hochladen der Dateien und die Verwendung eines Upload-Tokens wird eine klare Trennung der Upload- und Ticket-Verwaltungsprozesse ermöglicht, was besonders in automatisierten Systemen und selbst entwickelten Support-Interface von Vorteil ist. Die Verwendung der API erfordert eine sichere Authentifizierung und das Verständnis des zweistufigen Ablaufs vom Upload bis zur Verknüpfung mit Tickets oder Kommentaren.