Authentifizierung
Erfahren Sie, wie Sie sich bei der API authentifizieren.
API-Schlüssel
Die Authentifizierung erfolgt über API-Schlüssel. Um einen Schlüssel zu erstellen:
- Melden Sie sich im Admin-Bereich an
- Navigieren Sie zu Einstellungen > API
- Klicken Sie auf "Neuen API-Schlüssel erstellen"
- Wählen Sie die erforderlichen Bereiche aus
Verwendung von API-Schlüsseln
Übergeben Sie Ihren API-Schlüssel in einem der folgenden Header. Ein Query-Parameter wird nur akzeptiert, wenn der Plattformbetreiber ihn freigeschaltet hat:
Bearer Token (empfohlen)
curl -X GET "https://ihr-mandant.plandocket.com/api/v1/events" \
-H "Authorization: Bearer YOUR_API_KEY"X-API-Key Header
curl -X GET "https://ihr-mandant.plandocket.com/api/v1/events" \
-H "X-API-Key: YOUR_API_KEY"Query-Parameter Standardmäßig deaktiviert
curl -X GET "https://ihr-mandant.plandocket.com/api/v1/events?api_key=YOUR_API_KEY"Standardmäßig deaktiviert – diese Methode funktioniert nur, wenn der Plattformbetreiber sie freigeschaltet hat; andernfalls wird die Anfrage mit 401 abgelehnt. Sie wird nicht empfohlen, da der Schlüssel in Server-Logs und im Browserverlauf erscheinen kann. Verwenden Sie stattdessen den Authorization- oder X-API-Key-Header.
Bereiche
API-Schlüssel können auf bestimmte Bereiche beschränkt werden:
| Bereich | Zugriff |
|---|---|
events |
Lesen und Schreiben von Events |
contacts |
Lesen und Schreiben von Kontakten |
participants |
Lesen und Schreiben von Teilnehmern |
applications |
Lesen und Bearbeiten von Bewerbungen |
categories |
Lesen und Schreiben von Kategorien |
checkins |
Lesen und Erstellen von Check-ins |
invoices |
Lesen und Schreiben von Rechnungen |
payments |
Lesen und Erfassen von Zahlungen |
booths |
Lesen und Schreiben von Ständen und Reservierungen |
plans |
Lesen von Lageplänen |
schedules |
Lesen von Zeitplänen |
services |
Lesen von Dienstleistungen |
service_orders |
Lesen von Bestellungen |
submissions |
Lesen und Bearbeiten von Einreichungen |
documents |
Lesen und Erstellen von Dokumenten |
tasks |
Lesen und Schreiben von Aufgaben |
custom_fields |
Lesen und Schreiben von benutzerdefinierten Feldern |
lists |
Listeneinträge von Teilnehmern lesen und bearbeiten |
newsletter |
Verwalten von Newsletter-Abonnenten |
reports |
Abrufen von Berichten |
audit |
Lesen des Audit-Logs |
webhooks |
Verwalten von Webhooks |
calendar-feed |
Lesen des Kalender-Feeds |
Zugriffsstufen
Jeder Bereich kann mit einer Zugriffsstufe vergeben werden. Vergeben Sie Lesezugriff für Integrationen, die nur Daten exportieren (BI-Tools, Dashboards).
| Schreibweise | Erlaubte Anfragen |
|---|---|
contacts:read |
Nur Lesen: GET-Anfragen |
contacts:write |
Lesen und Schreiben: GET, POST, PUT, PATCH und DELETE |
contacts |
Lesen und Schreiben (Schlüssel, die vor Einführung der Zugriffsstufen erstellt wurden) |
Sicherheit
Wichtige Sicherheitshinweise
- API-Schlüssel niemals im Frontend-Code verwenden
- Schlüssel in Umgebungsvariablen speichern
- Schlüssel regelmäßig rotieren
- Nur die minimal erforderlichen Bereiche gewähren