Der Zugriff auf die Famly API wird vom Support-Team freigeschaltet. Wenn du die API für deine Einrichtung aktivieren möchtest, wende dich bitte an support@famly.de.
Die Famly API – basierend auf GraphQL
Unsere API basiert auf GraphQL und ist hier erreichbar:
https://famlyapi.famly.co/v1/graphql
Bevor du loslegst, empfehlen wir dir, dich mit GraphQL vertraut zu machen. Die offizielle Dokumentation findest du unter https://graphql.org.
💡 Hinweis: Die ofizielle GraphQL-Seite, sowie unsere Dokumentation zur API sind auf Englisch.
Für weitere Details kannst du auch direkt in unsere Dokumentation zur Public GraphQL API schauen:
Was kannst du mit der API abfragen oder bearbeiten?
Unsere API unterstützt derzeit folgende Bereiche (Roots):
accidentReports (Unfall-Berichte)
bankhours (Stundenkonto)
checkins (Eincheck-Zeiten)
employees (Mitarbeitende)
groups (Gruppen)
inquiries (Anfragen)
meals (Mahlzeiten)
sites (Einrichtungen)
children (Kinder)
contacts (Kontakte)
enquiries (Anfragen)
files (Dokumente - nur Mutationen, also Änderungen)
payments (Zahlungen)
invoices (Rechnungen)
billpayers (Rechnungszahler:innen)
Erkunde die API
GraphiQL
Wir bieten dir GraphiQL an – ein Tool, mit dem du direkt Abfragen ausprobieren kannst. Bitte beachte: Die meisten Abfragen funktionieren erst, wenn du authentifiziert bist. Über den Docs-Button oben rechts findest du hilfreiche Infos.
In GraphiQL siehst du links oben Beispiel-Abfragen und -Mutationen. Unten kannst du Variablen und Argumente eintragen. Das hilft dir, schnell loszulegen und Ideen zu sammeln.
Voyager
Mit Voyager bekommst du eine grafische Übersicht über den Aufbau der API. Das macht es leichter, die Struktur zu verstehen.
Authentifizierung
Um die Public API nutzen zu können, benötigst du ein Access Token. Melde dich dafür bitte beim Famly Support im In-App-Chat oder per E-Mail an support@famly.de.
Unser Support schaltet dir die Funktion frei und informiert dich darüber, wo du den Access Token findest.