REST API & API-Schlüssel - Admin-Handbuch

Unter Einstellungen → Entwickler → REST API verbinden Sie andere Programme (Buchhaltung, CRM, Website, Zapier oder Make) über API-Schlüssel mit PlanDocket. Jeder Schlüssel darf nur das, was Sie festlegen. Erfordert das Paket Business oder höher und die aktivierte Funktion "REST API". Die Endpunkte selbst beschreibt die API-Referenz dieser Dokumentation.

Programm verbinden

Der Kasten "So verbinden Sie ein Programm" zeigt alles, was das andere Programm braucht:

API Base-URL

Die Adresse, an die das Programm seine Anfragen sendet

Header "Authorization"

Darin trägt das Programm bei jeder Anfrage den API-Schlüssel ein

Schlüssel erstellen

Mit "API-Schlüssel erstellen" legen Sie einen neuen Schlüssel an:

Name

Bezeichnung, an der Sie den Schlüssel später erkennen, z. B. den Namen des Programms

Was darf das Programm?

Nur lesen (Daten abrufen, nichts ändern), Automatisierung (Zapier, Make) (Daten lesen und Webhooks einrichten), Lesen und ändern, Selbst auswählen oder Vollzugriff

Selbst auswählen

Für jeden Bereich einzeln Kein Zugriff, Nur lesen oder Lesen & schreiben festlegen. Mehr als Ihre eigene Rolle erlaubt, können Sie nicht vergeben

Bereiche

Unter anderem Veranstaltungen, Kontakte, Teilnehmer, Bewerbungen, Rechnungen und Gutschriften, Zahlungen, Zeitpläne, Aufgaben, Aktivitätsprotokoll, Webhooks verwalten und Kalender-Abo

Vollzugriff

Alles lesen und ändern, auch künftige Bereiche. Nur Super-Admins können Vollzugriff vergeben

Weitere Einstellungen (Ablaufdatum, Anfragelimit)

Optionales Ablaufdatum und Anfragen pro Stunde (100–10.000, Standard 1.000)

Schlüssel kopieren

Der Schlüssel wird nur einmal angezeigt. Tragen Sie ihn sofort im anderen Programm ein; haben Sie ihn verloren, erzeugen Sie einen neuen

Schlüssel verwalten

Über die Aktionen eines Schlüssels:

Vorübergehend ausschalten / Wieder einschalten

Den Zugriff pausieren, ohne den Schlüssel zu löschen

Neuen Schlüssel erzeugen

Der bisherige Schlüssel funktioniert danach sofort nicht mehr; tragen Sie den neuen im verbundenen Programm ein

An andere Person übertragen

Nur für Super-Admins. Die neue Person wird Inhaber, der Schlüssel bleibt gleich und die Verbindung läuft ohne Unterbrechung weiter

Löschen

Programme, die den Schlüssel verwenden, verlieren den Zugriff. Webhooks dieses Schlüssels werden dabei ausgeschaltet

Gesperrt

Schlüssel sind an die Person gebunden, die sie erstellt hat. Wird diese Person deaktiviert, hört der Schlüssel sofort auf zu funktionieren, bis ein Super-Admin ihn überträgt oder löscht

API-Nutzung

Einstellungen → Entwickler → API-Nutzung zeigt die Aufrufe aller Schlüssel:

Statistiken

Anfragen (30 Tage), Erfolgsrate, Fehlerrate und Durchschn. Antwortzeit

Filter

Alle API-Schlüssel, Alle Status, Endpunkt suchen sowie Von und Bis

Spalten

Zeitpunkt, API-Schlüssel, Methode, Endpunkt, Status, Antwortzeit und IP-Adresse

Tipps

Erstellen Sie für jedes verbundene Programm einen eigenen Schlüssel; so können Sie ihn einzeln ausschalten

Wählen Sie "Nur lesen", wenn das Programm nur Daten abrufen soll

Für ein Kalender-Abo (siehe Kalender) erstellen Sie einen Schlüssel, der ausschließlich den Bereich "Kalender-Abo" erlaubt

Hinweise

Erfordert das Paket Business oder höher, die aktivierte Funktion "REST API" und die Berechtigungen "Einstellungen ansehen" bzw. "Einstellungen bearbeiten"

Einen Schlüssel ändern können nur die Person, die ihn erstellt hat, und Super-Admins