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
Es gibt drei Möglichkeiten, Ihren API-Schlüssel zu übergeben:
Bearer Token (empfohlen)
curl -X GET "https://your-tenant.plandocket.com/api/v1/events" \
-H "Authorization: Bearer YOUR_API_KEY"X-API-Key Header
curl -X GET "https://your-tenant.plandocket.com/api/v1/events" \
-H "X-API-Key: YOUR_API_KEY"Query-Parameter
curl -X GET "https://your-tenant.plandocket.com/api/v1/events?api_key=YOUR_API_KEY"Diese Methode wird nicht empfohlen, da der Schlüssel in Logs erscheinen kann.
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 |
invoices |
Lesen und Schreiben von Rechnungen |
payments |
Lesen und Erfassen von Zahlungen |
tasks |
Lesen und Schreiben von Aufgaben |
documents |
Lesen und Erstellen von Dokumenten |
submissions |
Lesen und Bearbeiten von Einreichungen |
booths |
Lesen und Schreiben von Ständen und Reservierungen |
checkins |
Lesen und Erstellen von Check-ins |
services |
Lesen von Dienstleistungen |
service_orders |
Lesen von Bestellungen |
newsletter |
Verwalten von Newsletter-Abonnenten |
custom_fields |
Lesen und Schreiben von benutzerdefinierten Feldern |
plans |
Lesen von Lageplänen |
schedules |
Lesen von Zeitplänen |
webhooks |
Verwalten von Webhooks |
reports |
Abrufen von Berichten |
audit |
Lesen des Audit-Logs |
calendar-feed |
Lesen des Kalender-Feeds |
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