Technische Dokumentation: alle aktuellen API-Routen, Berechtigungen und Beispiele findest du unter docs.fitsociety.io. Beginne als Entwickler mit dem Public API-Schnellstart.
In diesem Artikel
Das API-Modul der FITsociety-App in Make ist für fortgeschrittene Szenarien gedacht, in denen du eine unterstützte Public-API-Route direkt nutzen möchtest. Für gewöhnliche Aktionen, etwa ein Mitglied aktualisieren oder eine Buchung erstellen, sind die verfügbaren FITsociety-Aktionsmodule meist einfacher.
Das API-Modul nutzt dieselbe Verbindung, dasselbe Unternehmen und dieselben Berechtigungen wie deine anderen Module. Es gewährt keinen zusätzlichen Zugriff auf Daten. Du brauchst Zugriff auf die FITsociety-App; frag den Helpdesk nach der privaten App, wenn sie in deinem Make-Konto noch nicht verfügbar ist.
Eine Leseanfrage vorbereiten
Suche die aktuelle Beschreibung der gewünschten Route der FITsociety Public API heraus.
Prüfe die HTTP-Methode, den Pfad, die benötigten Berechtigungen und die Eingabefelder.
Füge das API-Modul hinzu und wähle die Verbindung mit dem richtigen Unternehmen.
Wähle für eine Leseanfrage GET und gib den relativen Pfad gemäß der Modulhilfe ein.
Füge die erforderlichen Abfrageparameter in den dafür vorgesehenen Feldern hinzu.
Klicke auf Run once und prüfe den Antwortinhalt und den Statuscode.
Ein Verbindungstest nutzt die Public-API-Route GET /public/v1/me. Welchen Teil davon du im Modul eingibst, hängt vom Basispfad ab, den das Modul bereits verwendet. Folge der Modulhilfe und gib nicht einfach eine vollständige Website-URL oder einen Pfad aus der Coach-Umgebung ein.
Die Authentifizierung läuft über die ausgewählte Verbindung. Kopiere kein Zugriffstoken aus einer anderen Integration in dein Szenario. Eine funktionierende Verbindung gewährt nur Zugriff auf Routen, für die eine Zustimmung erteilt wurde.
Eine Anfrage, die Daten ändert
Nutze nur eine Schreibmethode, die sowohl das Modul als auch die betreffende API-Route unterstützen. Gib im dafür vorgesehenen Feld, etwa Source operation key, eine stabile Quellkennung an. Verwende bei einer Wiederholung derselben Änderung denselben Wert und dieselbe Eingabe.
Ein JSON-Body muss gültiges JSON enthalten. Zahlen verwenden darin einen Punkt als Dezimaltrennzeichen, zum Beispiel 172.5. Verwende keine Einheiten oder formatierten Beträge. Datumsfelder ohne Uhrzeit verwenden YYYY-MM-DD; Zeitpunkte folgen dem von der API geforderten Format mit Zeitzone.
Nutze beim Zuordnen von Freitext einen JSON-Builder, damit Anführungszeichen und Zeilenumbrüche korrekt verarbeitet werden. Teste Schreibaktionen mit fiktiven Daten. Eine erfolgreiche Anfrage kann Änderungen, Benachrichtigungen und andere normale Folgen auslösen.
Ergebnisse und mehrere Seiten prüfen
Prüfe im Antwortinhalt, ob der gewünschte Datensatz gefunden oder geändert wurde. Ein erfolgreicher Statuscode allein sagt nicht, ob dein Szenario alle gewünschten Datensätze verarbeitet hat.
Geh nicht davon aus, dass ein API-Modul automatisch alle Seiten abruft. Nutze die Paginierung, die Route und Modul unterstützen, und prüfe, ob weitere Ergebnisse folgen. Frag den FITsociety-Helpdesk nach der passenden Dokumentation, wenn du nicht sicher bist, welche Route, Berechtigungen oder Paginierung zu deinem Ziel passen.
Noch keine Verbindung? Lies FITsociety mit Make verbinden.