REST-API Schnittstelle

Intelligente Automatisierung für die Bedürfnisse deines Vereins

Hat dein Verein spezielle Anforderungen, die von den Zusatzmodulen von Clubway nicht abgedeckt werden? Kein Problem – mit der Programmierschnittstelle (API) von Clubway kannst du externe Systeme anbinden oder eigene Lösungen entwickeln, die genau auf eure Bedürfnisse zugeschnitten sind. Automatisiere den Alltag, reduziere manuelle Arbeit und verbinde Systeme nahtlos miteinander.

Bestellung des Zusatzmoduls

Das API-Zusatzmodul kann von einem Administrator für den Verein bestellt werden, danach können vom Administrator API-Schlüssel erstellt und verwaltet werden.

Einstellungen für API-Schlüssel

Diese Einstellungen können sowohl bei der Erstellung als auch bei der Bearbeitung von API-Schlüsseln geändert werden.

Mitglied: Jeder Schlüssel ist genau mit einem Mitglied verknüpft, und die Rechte des Schlüssels richten sich nach den Rollen, die diesem Mitglied (unter Einstellungen > Rollen) zugeordnet sind. Wir empfehlen, für jeden API-Schlüssel ein eigenes Mitglied mit entsprechendem Namen zu erstellen. Dadurch kann genau verfolgt werden, welche Aktionen über den API-Schlüssel und welche direkt durch ein wirkliches Mitglied durchgeführt wurden.
API-Schlüsselname: Ein eindeutiger Name für den Schlüssel, dient zur leichteren Identifizierung
Status: Hier kann ein Schlüssel vorübergehend blockiert werden.
Lese- und Schreibzugriff: Damit Daten nicht versehentlich überschrieben werden können, kann hier einstellt werden, dass der Schlüssel nur zum Lesen von Daten verwendet werden kann. Ein Schreibzugriff würde hier eine Fehlermeldung verursachen.
Sichtbarkeit der Mitgliedsfelder: Falls für den API-Zugriff keine Mitgliedsdaten erforderlich sind (z.B. wenn nur Termine abgerufen werden sollen), kann hier die Sichtbarkeit der Felder beschränkt oder ganz ausgeschlossen werden.

Verwendung der Schnittstelle

Jeder API-Schlüssel ist mit einem Mitglied verknüpft. Um die Schnittstelle verwenden zu können, wir das Token für den API-Schlüssel benötigt, diese Token wird genau einmal angezeigt und muss an einer sicheren Stelle gespeichert werden.

Anzeige des Tokens

Melde dich mit dem verknüpften Mitgliedskonto bei Clubway an
Gehe zur Mitglieder-Seite und klicke auf den Namen des Mitgliedskontos
Wähle API-Schlüssel
Klicke auf Anzeigen und kopiere das Token für den API-Schlüssel

Wichtiger Sicherheitshinweis

Verschicke das Token niemals per E-Mail und teile es nicht mit anderen. Das Token muss vertraulich behandelt werden.

Regenerieren des Tokens

Wenn du vermutest, dass das Token in falsche Hände geraten ist, kann es regeneriert werden oder der Administrator kann den API-Schlüssel vorübergehend deaktivieren.

Dokumentation der Schnittstelle

Hier findest du alle Funktionen und Beschreibungen der API in Englisch: https://taikala.github.io/myclub-api-docs/de

Es gibt keine Testumgebung.

Beachte bitte, dass es sich um eine Experten-API handelt, mit der komplette Vereins-individuelle Lösungen möglich sind. Die Nutzung ist daher nicht durch den kostenlosen Produktsupport abgedeckt.