API-Token und Entwicklerzugriff

Deskwoot stellt eine REST API bereit, die Ihnen programmgesteuerten Zugriff auf Ihre Supportdaten und Abläufe gibt. Egal ob Sie eigene Integrationen bauen, Ticketdaten mit internen Tools abgleichen oder wiederkehrende Aufgaben automatisieren: Mit API-Token authentifizieren Sie sich sicher, ohne Ihre Anmeldedaten weiterzugeben. Dieser Leitfaden führt Sie durch das Erzeugen von Token, Ihren ersten API-Aufruf und die Praktiken, die Ihr Konto sicher halten.

Die REST API ist eine Enterprise-Funktion. Sie ist außerdem während der 7-tägigen Enterprise-Testphase verfügbar, mit der jedes neue Konto startet, sodass Sie damit bauen und testen können, bevor Sie sich festlegen. Wenn Sie in einem niedrigeren Tarif sind und API-Zugriff brauchen, müssen Sie auf Enterprise wechseln. Ein vollständigeres Bild davon, was die API abdeckt, finden Sie im Überblick zur REST API.

Wie erzeuge ich ein API-Token?

1. Melden Sie sich bei Ihrem Deskwoot-Konto an und gehen Sie zu Einstellungen > API-Token.
2. Klicken Sie auf die Option, ein neues Token zu erstellen.
3. Geben Sie dem Token einen aussagekräftigen Namen (zum Beispiel CRM-Sync, Produktion), damit Sie seinen Zweck später erkennen.
4. Wählen Sie die konkreten Berechtigungen, die das Token haben soll. Gewähren Sie nur die Zugriffsebenen, die Ihre Integration tatsächlich braucht.
5. Bestätigen Sie und kopieren Sie das Token sofort. Aus Sicherheitsgründen wird das vollständige Token möglicherweise nicht erneut angezeigt, nachdem Sie die Seite verlassen haben.

Wie nutze ich die API?

Alle API-Anfragen werden gegen die folgende Basis-URL gestellt:

https://deskwoot.com/api/v1/

Fügen Sie Ihr API-Token in den Authorization-Header jeder Anfrage ein:

Authorization: Bearer YOUR_TOKEN

Beispielanfrage

Ein einfacher cURL-Aufruf zum Testen Ihrer Verbindung könnte so aussehen:

curl -H "Authorization: Bearer YOUR_TOKEN" https://deskwoot.com/api/v1/

Ist das Token gültig, gibt die API eine erfolgreiche Antwort zurück. Wenn nicht, erhalten Sie einen Authentifizierungsfehler.

Was sind die bewährten Praktiken?

• So wenig Zugriff wie nötig gewähren. Weisen Sie jedem Token nur die Berechtigungen zu, die es braucht. Vermeiden Sie Token mit vollem Admin-Zugriff, sofern Sie ihn nicht wirklich benötigen.
• Token regelmäßig wechseln. Widerrufen Sie alte Token von Zeit zu Zeit und erzeugen Sie neue, besonders wenn Teammitglieder die Rolle wechseln oder ausscheiden.
• Token sicher speichern. Bewahren Sie Token in Umgebungsvariablen oder einem Secrets-Manager auf. Schreiben Sie sie nie fest in clientseitigen Code und legen Sie sie nie in die Versionsverwaltung.
• Aussagekräftige Namen verwenden. Token nach der Integration oder Umgebung zu benennen, der sie dienen, macht die Überprüfung einfach.
• Nutzung überwachen. Prüfen Sie Ihre aktiven Token regelmäßig unter Einstellungen > API-Token und löschen Sie alle, die nicht mehr verwendet werden.

Wie behebe ich Token-Fehler?

• 401 Unauthorized: Prüfen Sie genau, ob das Token korrekt kopiert wurde, nicht widerrufen ist und mit dem Präfix Bearer im Header enthalten ist.
• 403 Forbidden: Dem Token fehlen möglicherweise die Berechtigungen für den Endpunkt, den Sie aufrufen. Bearbeiten Sie das Token oder erstellen Sie es mit dem richtigen Zugriff neu.
• Rate-Limiting: Wenn Sie Rate-Limit-Fehler erhalten, verringern Sie, wie oft Sie die API aufrufen, oder fügen Sie Ihrem Code ein exponentielles Backoff hinzu.

Häufig gestellte Fragen

Ist die REST API in allen Tarifen verfügbar?

Nein. Die REST API ist eine Enterprise-Funktion und außerdem während der 7-tägigen Enterprise-Testphase verfügbar. Niedrigere bezahlte Tarife enthalten sie nicht.

Kann ich mehrere API-Token erstellen?

Ja. Sie können so viele Token erzeugen, wie Sie brauchen. Es empfiehlt sich, für jede Integration oder Umgebung ein eigenes Token zu erstellen, damit Sie eines widerrufen können, ohne die anderen zu beeinträchtigen.

Was passiert, wenn mein Token kompromittiert wird?

Gehen Sie sofort zu Einstellungen > API-Token, widerrufen Sie das kompromittierte Token und erzeugen Sie ein neues. Aktualisieren Sie alle Dienste, die auf das alte Token angewiesen waren.

Was, wenn ich stattdessen einen KI-Agenten den Helpdesk nutzen lassen möchte?

Wenn Sie einen externen KI-Agenten Deskwoot bedienen lassen möchten, statt Ihre eigene Integration zu bauen, sehen Sie sich den MCP-Server an. Auch er ist eine Enterprise-Funktion und nutzt eingeschränkte Bot-Token.