Entwickler/Einführung

fepli API

Die fepli API zeigt Ihren eigenen Systemen dasselbe Programm, das Admins im Admin-Panel sehen: Angebote, Saisons, Veranstalter:innen, Konten, Anmeldungen und Belege. Sie kann auch tun, was das Admin-Panel tut, etwa ein Angebot veröffentlichen, eine Anmeldung bestätigen oder eine Zahlung erfassen.

So funktioniert es

Die API spricht JSON über HTTPS. Jede Organisation betreibt ihr eigenes fepli und hat deshalb einen eigenen Endpunkt: meist /api auf dem Host des Admin-Panels. Wie Sie Ihren finden, steht im Schnellstart.

• Ohne Token lesen Sie die veröffentlichten Angebote der Saisons, die online sind. Es sind dieselben, die die öffentliche Website zeigt. Die Bausteine zeigen dieselben Angebote auf Ihrer Website.
• Mit Token sehen und tun Sie, was die Inhaber:in des Tokens im Admin-Panel sehen und tun darf. Ein Token ist entweder das persönliche API-Token einer Kolleg:in (pat-…) oder gehört zu einem Service-Account (svc-…). Das ist eine Maschinenidentität mit eigenen Rollen.
• Jedes Token ist entweder nur lesend oder lesend und schreibend. Ein Token, das nur lesen darf, ändert nichts, welche Rollen es auch hat.

Leitfäden

AuthentifizierungWie Sie ein persönliches Token oder das Token eines Service-Accounts mitsenden und was Lese- und Schreibzugriff bedeuten.Service-AccountsEine eigene Identität für eine Integration oder einen KI-Agenten, auf Wunsch auf Lesezugriff beschränkt.BerechtigungenWelche Rollen welche Endpunkte öffnen, was Veranstalter:innen sehen und wann personenbezogene Daten maskiert werden.KonventionenKennungen, Referenzen, Datumsangaben, Beträge, Filter und die Regeln für PATCH. Sie gelten für jeden Endpunkt.PaginierungLange Listen Seite für Seite abrufen.FehlerDie Statuscodes der API, ihre Bedeutung und die passende Reaktion.Angebote auf Ihrer WebsiteDie aktuellen Angebote auf Ihrer Website oder in einer App zeigen, ohne Token.Support-AgentenEin Agent beantwortet die Fragen einer verifizierten Familie zu ihrem Konto.UmstiegWas sich geändert hat, seit die API nur Angebote kannte.

Ressourcen

AngeboteDie Aktivitäten einer Saison, mit Terminen, Beitrag und Plätzen. Ohne Token öffentlich lesbar; mit Token legen Sie Angebote an, ändern und veröffentlichen sie.SaisonsDie Zeiträume, zu denen Angebote gehören, mit den Phasen, in denen Veranstalter:innen Angebote bearbeiten, Familien sich anmelden und Teilnahmelisten sichtbar werden.Veranstalter:innenDie Vereine, Unternehmen und Abteilungen, die Angebote durchführen, mit Kontaktdaten und Mitgliedern.Veranstalter-EinladungenPersonen als Mitglieder zu einem Veranstalter-Profil einladen oder dazu, ein neues anzulegen. Einladungen erneut senden und zurückziehen.AnmeldungenWer sich wofür angemeldet hat und in welchem Status. Teilnehmer:innen anmelden, zusagen, auf die Warteliste setzen oder abmelden.KontenFamilien, Veranstalter:innen und Admins: Kontaktdaten, Rollen, Teilnehmer:innen und Saldo.Teilnehmer:innenDie Kinder und Jugendlichen, die teilnehmen, mit ihren Anmeldungen nach Status.BelegeZahlungen, Rechnungen und Stornos. Eine Zahlung an der Kasse annehmen, einer Familie eine Rechnung stellen oder einen Beleg stornieren.Debitor:innenDas Konto jeder Familie: was sie gezahlt hat, was offen ist und ihr Saldo. Freie Buchungen anlegen.EinwilligungenDie Einwilligungen von Familien und Veranstalter:innen und ob sie noch gelten.KommentareDie Notizen der Admins zu Angeboten, Anmeldungen, Personen und Saisons. Lesen und eigene ergänzen.RundmailsEine Rundmail an Familien oder Veranstalter:innen senden, wie im Admin-Panel. Teilt Familien festgeschriebene Entscheidungen mit.Gesendete NachrichtenJede E-Mail und SMS, die das System verschickt hat, mit ihrem Zustellstatus.KategorienDie Kategorien, denen Angebote zugeordnet sind.Zugangscode-ListenDie Codes, die eine Saison verlangen kann, bevor Familien sich anmelden. Für Programme, die nur manchen Familien offenstehen.SucheEine Abfrage über Angebote, Saisons, Teilnehmer:innen, Konten, Veranstalter:innen und Belege.MeWem ein Token gehört, was es darf und für welchen Mandanten es arbeitet.