API-Authentifizierung

platzeo.de hat eine lesende API unter https://platzeo.de/api/v1. Jede Anfrage braucht einen API-Schlüssel oder ein OAuth-Zugriffstoken und gilt für genau ein Restaurant. Alle Einzelheiten stehen in der API-Referenz.

API-Schlüssel erstellen

1. Öffnen Sie im Admin Einstellungen → API-Schlüssel und klicken Sie auf Schlüssel erstellen.
2. Vergeben Sie einen Namen, auf Wunsch ein Ablaufdatum, und wählen Sie, was der Schlüssel darf: das Restaurantprofil mit Öffnungszeiten abrufen, freie Zeiten abrufen oder beides. Andere Berechtigungen kann ein Schlüssel nicht bekommen, weil die API dafür keine Endpunkte hat.
3. Der Schlüssel wird nur dieses eine Mal angezeigt. Kopieren Sie ihn und bewahren Sie ihn sicher auf.

Einen Schlüssel, den Sie nicht mehr brauchen, widerrufen Sie auf derselben Seite. Er wird danach sofort abgelehnt.

Schlüssel senden

Der Schlüssel beginnt mit plz_live_ und steht bei jeder Anfrage im Header X-API-Key. Im Header Authorization wird er nicht angenommen. Ein Tausch gegen ein Token ist nicht nötig.

curl https://platzeo.de/api/v1/restaurants \
  -H "X-API-Key: plz_live_..."

OAuth für Anwendungen

Anwendungen, die im Namen einer Person auf ein Restaurant zugreifen, nutzen OAuth 2.0 mit Authorization Code und PKCE. So verbindet sich zum Beispiel das WordPress-Plugin. Das Zugriffstoken beginnt mit plz_at_, gilt eine Stunde und steht im Header Authorization: Bearer. Die Clients registriert platzeo. Ablauf und Adressen stehen in der API-Referenz.

Verbinden kann, wer im Restaurant externe Anwendungen verbinden darf: Inhaber und Manager, dazu eigene Rollen mit diesem Recht. Wer für mehrere Restaurants verbinden darf, wählt auf der Freigabeseite eines aus.

Verbundene Anwendungen

Unter Einstellungen → Anwendungen sehen Inhaber und Manager jede verbundene Anwendung: ihren Namen, die Website, was sie abrufen darf, wer sie wann verbunden hat und wann sie zuletzt verwendet wurde. Mit Trennen endet die Verbindung sofort.

Eine Verbindung endet außerdem,

• wenn die Anwendung sie selbst trennt,
• wenn dieselbe Website für dasselbe Restaurant neu verbunden wird: Die neue Verbindung ersetzt die bisherige,
• wenn die Person, die sie hergestellt hat, das Team des Restaurants verlässt, ihr Passwort ändert oder das Recht verliert, Anwendungen zu verbinden,
• nach zwölf Monaten ohne Nutzung.

Danach verbinden Sie die Anwendung neu.

Limit

Erlaubt sind 100 Anfragen pro Minute je API-Schlüssel, bei OAuth je Person. Darüber antwortet die API mit Status 429 und nennt im Header Retry-After die Wartezeit in Sekunden.