API-Schlüssel

Mit API-Schlüsseln greifen Sie programmatisch auf die ZEPDESK V1-API Ihres Tenants zu. Jeder Schlüssel hat einen eigenen Namen, ist auf eine oder mehrere Firmen scoped und trägt definierte Berechtigungen (Scopes).

Direkt-Link

→ Jetzt zu „Mein Konto → API Keys" wechseln

Sie müssen am Portal angemeldet sein. Falls noch nicht geschehen, fordert das System einen OTP-Login per E-Mail an.

API-Key erstellen

1. Navigieren Sie zu Mein Konto → API Keys.
2. Klicken Sie auf Neuen Schlüssel erstellen.
3. Vergeben Sie einen aussagekräftigen Namen (z. B. „Buchhaltungssystem").
4. Wählen Sie die Firma(s), für die der Schlüssel gelten soll.
5. Wählen Sie die gewünschten Scopes (Berechtigungen).
6. Klicken Sie auf Erstellen.

Achtung

Der vollständige API-Schlüssel wird nur einmal angezeigt. Kopieren Sie ihn sofort und speichern Sie ihn sicher (z. B. in einem Passwort-Manager oder als Umgebungsvariable). Nach dem Schließen des Dialogs kann der Schlüssel nicht mehr eingesehen werden.

API-Key widerrufen

Wenn ein API-Schlüssel kompromittiert oder nicht mehr benötigt wird:

1. Navigieren Sie zu Mein Konto → API Keys.
2. Klicken Sie auf den betreffenden Schlüssel.
3. Klicken Sie auf Widerrufen.

Das Widerrufen ist sofort wirksam und kann nicht rückgängig gemacht werden.

Wo finde ich die vollständige API-Referenz?

Die technische Doku, alle Endpoints, Request-/Response-Schemas, Auth-Details, Pagination, Rate-Limits, Error-Codes, Webhooks, liegt im Tenant-Frontend unter dem Pfad:

https://<ihre-subdomain>.zepdesk.de/<FIRMA>/api-docs

Die Referenz wird dort als interaktive Redoc-Seite gerendert und enthält cURL-Beispiele für jeden Endpoint.

Sicherheitsempfehlungen

• Ein Schlüssel pro Integration: damit Sie einzelne Integrationen gezielt deaktivieren können.
• Minimale Berechtigungen: vergeben Sie nur die Scopes, die tatsächlich benötigt werden.
• Regelmäßige Rotation: empfohlen alle 90 Tage.
• Keine Hardcoding: speichern Sie Schlüssel in Umgebungsvariablen, nicht im Quellcode.
• HTTPS only: API-Anfragen werden ausschließlich über HTTPS akzeptiert.