Authentifizierung
So authentifizieren Sie sich mit der planni Public API über API-Schlüssel.
Basis-URL
Alle API-Anfragen verwenden die folgende Basis-URL:
https://api.planni.de/v1API-Schlüssel
Jede Anfrage muss einen X-Api-Key-Header mit einem gültigen API-Schlüssel enthalten.
curl -H "X-Api-Key: ihr-api-schluessel" https://api.planni.de/v1/contactsAPI-Schlüssel werden im planni Admin unter Einstellungen > Integrationen erstellt.
Scopes
Jedem API-Schlüssel können ein oder mehrere Scopes zugewiesen werden:
| Scope | Beschreibung |
|---|---|
contacts:read | Kontakte lesen |
contacts:write | Kontakte erstellen und bearbeiten |
orders:read | Bestellungen lesen |
events:read | Veranstaltungsregistrierungen lesen |
webhooks:manage | Webhook-Abonnements verwalten |
Ein API-Schlüssel ohne Scopes hat vollen Zugriff (Abwärtskompatibilität).
Pagination
Listen-Endpunkte unterstützen Pagination mit limit und offset:
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
limit | Integer | 25 | Max. zurückgegebene Einträge |
offset | Integer | 0 | Zu überspringende Einträge |
curl -H "X-Api-Key: ihr-api-schluessel" \
"https://api.planni.de/v1/contacts?limit=10&offset=20"Fehlerbehandlung
Die API gibt Standard-HTTP-Statuscodes zurück.
Fehlerantworten
{
"error": "Unauthorized",
"message": "Missing or invalid API key"
}Statuscodes
| Status | Bedeutung |
|---|---|
| 400 | Ungültige Anfrage (fehlende/falsche Parameter) |
| 401 | Fehlender oder ungültiger API-Schlüssel |
| 403 | Unzureichende Berechtigung für diesen Endpunkt |
| 404 | Ressource nicht gefunden |
| 500 | Interner Serverfehler |
Rate Limiting
Derzeit gibt es keine Rate Limits. Dies kann sich in zukünftigen Versionen ändern.