API-Keys – Erstellen und Verwalten
Ein API-Key ist ein digitaler Zugangsschlüssel. Damit können externe Programme sicher auf ausgewählte Daten deines Eventfrog-Kontos zugreifen, zum Beispiel um Events automatisch zu aktualisieren oder Systeme miteinander zu verbinden. Du bestimmst dabei selbst, ob du einen Key nutzt, welche Berechtigungen er hat und wie lange er gültig bleibt.
Übersicht:
Wo finde ich die API-Keys?
Die Verwaltung deiner API-Keys findest du in deinem Kundenkonto unter «Einstellungen» und dem Punkt «API-Keys». In der Liste werden alle von dir erstellten API-Keys angezeigt – inklusive Name, Schlüssel-Typ, Gültigkeitsdauer und Zeitpunkt der letzten Nutzung. Du kannst bestehende Schlüssel bearbeiten, sofern sie ihre maximale Laufzeit noch nicht erreicht haben und die angezeigte Bezeichnung oder das Ablaufdatum anpassen.
Du kannst also:
- Keys erstellen
- bestehende Schlüssel einsehen
- Ablaufdaten prüfen
- Bezeichnungen bearbeiten
- den Schlüssel kopieren
Ein Link zur technischen API-Dokumentation ist auf dieser Seite jederzeit sichtbar. Aus Sicherheitsgründen wird der eigentliche Schlüssel nie im Klartext dargestellt. Erst wenn du gezielt auf «API-Key anzeigen» klickst, erscheint er in einem geschützten Fenster und kann von dort kopiert werden.
API-Key erstellen
Im Erstellvorgang wählst du zunächst den Typ des Keys aus. Je nach Einsatzzweck kann er nur lesenden Zugriff ermöglichen oder zusätzlich das Bearbeiten und Löschen deiner Eventdaten erlauben. Optional kannst du eine Bezeichnung vergeben, damit du später leichter erkennst, wofür der Key gedacht ist. Abschliessend legst du das Gültigkeitsdatum fest und erstellst den Key mit einem Klick. Dieser erscheint sofort in der Übersicht.
So funktioniert’s:
- «API-Key erstellen» anklicken
- Schlüssel-Typ auswählen (z. B. nur lesen oder auch bearbeiten/löschen)
- Bezeichnung eingeben (optional)
- Gültigkeitsdatum festlegen
- Vorgang bestätigen
Schlüssel-Typen im Überblick
Es gibt drei Schlüssel-Typen: den Public API-Key für das Auslesen öffentlicher Eventdaten, den Organizer API-Key mit reinem Lesezugriff sowie den Organizer API-Key mit Lese-, Schreib- und Löschrechten. Zusätzlich existiert ein sogenannter Embed-Key, der automatisch erzeugt wird, sobald du den Eventfrog-Ticketshop einbindest. Dieser wird nicht in der Übersicht angezeigt und kann nicht für API-Abfragen verwendet werden.
Jeder API-Key läuft automatisch zum hinterlegten Datum ab. Vorher informieren wir dich per E-Mail – 14 Tage, 7 Tage und 1 Tag vor Ablauf. Die Erinnerungen enthalten den Namen und den Typ des Keys sowie einen Link zur Verwaltung. Der Schlüssel selbst wird aus Sicherheitsgründen nie per Mail verschickt. Nach Ablauf bleibt ein Key noch zwölf Monate sichtbar, kann aber nicht mehr genutzt oder bearbeitet werden. Danach wird er automatisch ausgeblendet.
Schlüssel für Dritte freigeben
Wenn du externen Personen Zugriff ermöglichen möchtest, kannst du einen passenden API-Key selbst erstellen und weitergeben. Organizer-Keys gelten immer ausschliesslich für Events, die du angelegt hast. Soll beispielsweise eine Agentur Daten abrufen oder Inhalte verwalten, bestimmst du die Zugriffsrechte über den Key.
Um Missbrauch zu verhindern, gibt es automatische Begrenzungen, wie oft ein Key genutzt werden kann. Pro Benutzerkonto sind maximal 30 Anfragen pro Minute und 2.000 Anfragen pro Tag erlaubt – unabhängig davon, wie viele API-Keys existieren. Alle Zugriffe werden technisch aufgezeichnet und überwacht.
Bestehende API-Keys
Falls du bereits früher API-Keys genutzt hast, wurden diese automatisch übernommen. Schlüssel, die nur für Ticketshop-Einbindungen verwendet wurden, erhielten den Typ „Embed“. Keys, die Eventdaten über die API abgefragt haben, wurden als „Public API“ eingestuft. Sollten Keys früher beides getan haben, erstellen wir einen neuen Schlüssel für die öffentliche Nutzung und informieren dich darüber.
Technische URL
Die Eventfrog-APIs sind erreichbar unter:
api.eventfrog.net