Ihre Tools über die API verbinden
Die API ermöglicht einer Drittanwendung den programmatischen Zugriff auf die Daten Ihrer Organization: Mitgliederbestand, Kalender, Buchungen und Abrechnung. Sie wird mit zwei Klicks aktiviert und durch einen Schlüssel, eine Liste zugelassener Adressen sowie eine Nutzungsüberwachung geschützt.
Feststellen, ob die API für Sie relevant ist
Die API richtet sich an Entwickler, nicht an Verantwortliche einer Organization. Sie dient dazu, Ihr Konto mit einer Software kommunizieren zu lassen, die Sie entwickeln oder konfigurieren lassen: eine individuelle Website, ein Buchhaltungsprogramm, eine selbst gebaute Anzeigetafel, eine Schnittstelle zu einem anderen System.
Für die gängigen Anforderungen – die Mitgliederliste abrufen, Subscriptions in großer Zahl aktualisieren, Zahlen an den Vorstand übermitteln – genügen die Module für Import, Export und Berichte, ohne eine einzige Zeile Code zu schreiben.
Die API wird als Beta-Version angeboten: Ihre Funktionsweise kann sich noch ändern.
Die API aktivieren und Ihren Schlüssel abrufen
- Öffnen Sie Verwaltung›Einstellungen›API BETA.
- Aktivieren Sie API-Modul aktivieren und klicken Sie anschließend auf Speichern.
- Ihr API-Schlüssel wird angezeigt: Kopieren Sie ihn mit der Schaltfläche Kopieren und geben Sie ihn ausschließlich an das Tool weiter, das Sie anbinden.
Der Schlüssel wird im HTTP-Header X-API-Key jeder Anfrage übermittelt. Die Aufrufe erfolgen zwingend über HTTPS; unverschlüsselte Anfragen werden nicht angenommen.
Den Schlüssel schützen
Einige Grundregeln sollten Sie dem Tool oder dem Dienstleister, der es nutzt, in Erinnerung rufen:
- den Schlüssel niemals in einem Code-Repository ablegen; ihn in einer Konfigurationsdatei außerhalb des Repositorys oder in einem Secrets-Manager speichern;
- die zugelassenen Adressen einschränken, sobald das Tool von einem festen Server aus aufruft;
- den Schlüssel beim geringsten Zweifel neu generieren – versehentliche Veröffentlichung, Abfluss von Protokolldateien, Ende des Auftrags eines Dienstleisters.
Die Schaltfläche Regenerieren verlangt eine Bestätigung und macht den alten Schlüssel anschließend sofort ungültig. Alle Anwendungen, die ihn verwendet haben, funktionieren nicht mehr, solange sie den neuen Schlüssel nicht erhalten haben: Informieren Sie sie, bevor Sie klicken.
Den Zugriff nach IP-Adresse einschränken
Aktivieren Sie die Einschränkung nach IP-Adresse: Nur Anfragen von den Adressen, die Sie auflisten, werden angenommen, und zwar bis zu 10 IPv4-Adressen. Geben Sie jede Adresse ein und bestätigen Sie mit Hinzufügen; Ihre aktuelle Adresse wird zur Hilfe auf dem Bildschirm angezeigt.
Das ist der wirksamste und am häufigsten vernachlässigte Schutz: Selbst wenn er bekannt wird, bleibt ein auf die Adresse Ihres Dienstleisters beschränkter Schlüssel anderswo unbrauchbar.
Die Nutzung überwachen
Der Bildschirm zeigt fortlaufend an, was Ihr Schlüssel verbraucht:
- Nutzung in dieser Minute und Nutzung heute, jeweils bezogen auf das entsprechende Limit, sofern ein Limit konfiguriert ist;
- Nutzungsstatistiken: Diese Woche, Diesen Monat, Gesamt und Letzte Anfrage.
Jenseits der angegebenen Limits werden weitere Anfragen vorübergehend abgewiesen. Ein Zähler, der ständig knapp unter seiner Obergrenze liegt, deutet in der Regel auf ein schlecht eingestelltes Tool hin, das dieselben Daten immer wieder abruft, anstatt sie zwischenzuspeichern.
Das Datum der letzten Anfrage ist in umgekehrter Richtung nützlich: Ein aktivierter, aber seit Monaten nie aufgerufener Schlüssel ist ein Schlüssel, den Sie deaktivieren sollten.
Entdecken, was die API ermöglicht
Die vollständige Dokumentation mit den Parametern und Aufrufbeispielen wird am unteren Ende des Modulbildschirms angezeigt. In groben Zügen:
- Users: Dies ist die einzige veränderbare Ressource. Sie können Konten auflisten, einsehen, erstellen, ändern und löschen.
- Configuration: Subscriptions, Profile, Gruppen und Alterskategorien können eingesehen, aber ausschließlich in der Anwendung konfiguriert werden.
- Buchung: Kalender, verfügbare Time Slots, Bookings und Labels können eingesehen werden.
- Billing: Billing accounts, Orders und Zahlungen können eingesehen werden.
