Ihre Tools mit der API verbinden
Die API ermöglicht einer Drittanbieter-Anwendung, programmgesteuert auf die Daten Ihres Clubs zuzugreifen: Mitgliederbestand, Kalender, Buchungen und Abrechnung. Sie wird mit zwei Klicks aktiviert und durch einen Schlüssel, eine Liste autorisierter Adressen und eine Verbrauchsüberwachung geschützt.
Prüfen, ob die API für Sie relevant ist
Die API richtet sich an Entwickler, nicht an Club-Manager. Sie dient dazu, Ihr Konto mit einer Software zu verbinden, die Sie entwickeln oder konfigurieren lassen: eine maßgeschneiderte Website, ein Buchhaltungstool, ein eigenes Anzeigedisplay oder eine Schnittstelle zu einem anderen System.
Für übliche Anforderungen — die Mitgliederliste abrufen, Subscriptions gesammelt aktualisieren, Zahlen an den Vorstand übermitteln — reichen die Import-, Export- und Berichtsmodule aus, ohne eine einzige Codezeile zu schreiben.
Die API wird als Beta-Version angeboten: ihre Funktionsweise kann sich noch ändern.
Die API aktivieren und Ihren Schlüssel abrufen
- Gehen Sie zu Verwaltung›Einstellungen›API BETA.
- Aktivieren Sie API-Modul aktivieren und klicken Sie dann auf Speichern.
- Ihr API-Schlüssel wird angezeigt: Kopieren Sie ihn mit der Schaltfläche Kopieren und geben Sie ihn nur an das Tool weiter, das Sie verbinden.
Der Schlüssel wird im HTTP-Header X-API-Key jeder Anfrage übermittelt. Die Aufrufe müssen zwingend über HTTPS erfolgen; unverschlüsselte Anfragen werden nicht akzeptiert.
Den Schlüssel schützen
Einige Grundregeln sollten dem Tool oder dem Dienstleister, der es verwendet, in Erinnerung gerufen werden:
- Legen Sie den Schlüssel niemals in einem Code-Repository ab. Speichern Sie ihn in einer Konfigurationsdatei außerhalb des Repositorys oder in einem Secret-Manager.
- Beschränken Sie die autorisierten Adressen, sobald das Tool von einem festen Server aus aufruft.
- Generieren Sie den Schlüssel beim geringsten Zweifel neu — versehentliche Veröffentlichung, Protokoll-Leck, Ende des Auftrags eines Dienstleisters.
Die Schaltfläche Regenerieren fordert eine Bestätigung an und macht den alten Schlüssel sofort ungültig. Alle Anwendungen, die ihn verwendet haben, funktionieren nicht mehr, bis sie den neuen Schlüssel erhalten haben: Informieren Sie sie, bevor Sie klicken.
Den Zugriff nach IP-Adresse beschränken
Aktivieren Sie Einschränkung nach IP-Adresse: Nur Anfragen von den Adressen, die Sie auflisten, werden akzeptiert, begrenzt auf 10 IPv4-Adressen. Geben Sie jede Adresse ein und bestätigen Sie mit Hinzufügen; Ihre aktuelle Adresse wird auf dem Bildschirm angezeigt, um Ihnen zu helfen.
Das ist der wirksamste Schutz und der am häufigsten vernachlässigte: Selbst wenn er offengelegt wird, bleibt ein auf die Adresse Ihres Dienstleisters beschränkter Schlüssel anderswo unbrauchbar.
Den Verbrauch überwachen
Der Bildschirm zeigt laufend an, was Ihr Schlüssel verbraucht:
- Nutzung in dieser Minute und Nutzung heute, jeweils im Verhältnis zum Limit, wenn ein Limit konfiguriert ist;
- Nutzungsstatistiken: Diese Woche, Diesen Monat, Gesamt und Letzte Anfrage.
Über die angegebenen Limits hinaus werden zusätzliche Anfragen vorübergehend abgelehnt. Ein Zähler, der dauerhaft nahe an seiner Obergrenze liegt, weist in der Regel auf ein falsch eingestelltes Tool hin, das dieselben Daten immer wieder anfordert, statt sie im Cache zu speichern.
Das Datum der letzten Anfrage ist auch in die andere Richtung hilfreich: Ein aktivierter Schlüssel, der seit Monaten nie aufgerufen wurde, sollte deaktiviert werden.
Entdecken, was die API ermöglicht
Die vollständige Dokumentation mit Parametern und Aufrufbeispielen wird am unteren Rand des Modulbildschirms angezeigt. Im Überblick:
- Benutzer: Dies ist die einzige änderbare Ressource. Sie können Konten auflisten, anzeigen, erstellen, ändern und löschen.
- Konfiguration: Subscriptions, Profile, Gruppen und Alterskategorien können angezeigt werden, werden aber ausschließlich in der Anwendung konfiguriert.
- Buchung: Kalender, verfügbare Zeitfenster, Buchungen und Sperrvermerke können angezeigt werden.
- Abrechnung: Abrechnungskonten, Bestellungen und Zahlungen können angezeigt werden.
