(Liste und Details für externe Websites)

Veröffentlichung: Oktober 2026 | Für: Entwickler & Integratoren | Fairgate FSA-API (v2.0)

Was ist neu?

Die Fairgate FSA-API bietet neu zwei lesende Schnittstellen für Events: eine Eventsliste und die Eventdetails pro Organisation. Externe Websites können damit Events, Preise, den Anmeldestatus und die Inhalte der Ausschreibung eines Vereins anzeigen. Authentifizierung, Versionierung und Gateway funktionieren genau wie bei der Contacts-API (v2.0).

Zurückgegeben werden nur veröffentlichte, öffentliche Events. Was ein Verein in den Einstellungen der Ausschreibung ausblendet, bleibt auch in der Antwort ausgeblendet. Sie können nach Status und Zeitraum filtern, ein Event samt Teilevents laden und alle Texte in der gewünschten Sprache erhalten.

Der Ablauf im Überblick

Wie aktiviere ich den API-Zugriff? (1)

Für Administratoren. Gehen Sie zu Einstellungen → FSA Service und öffnen Sie den Reiter Kontakte-/Events-API.

• Stellen Sie API aktivieren auf Aktiviert.

• Erstellen Sie weiter unten auf derselben Seite Ihre Zugriffstoken.

• Eine Aktivierung und ein Satz Zugriffstoken gelten für die Kontakte- und die Events-Schnittstelle. Die Events-API wird gemäss der FSA-API vorkonfiguriert bereitgestellt.

Abbildung 1: Einstellungen → FSA Service → Kontakte-/Events-API mit dem Schalter «API aktivieren»

Wie rufe ich die Eventsliste ab? (2)

Für Entwickler. Senden Sie eine GET-Anfrage, mit Ihrer Organisations-ID als {oid}:

• GET /fsa/v2.0/event/{oid}/events

  
  

• Die Events sind nach dem frühesten Startdatum sortiert, die nächsten zuerst.

• Vergangene Events werden nicht angezeigt, ausser Sie verwenden time_filter=pastevents.

• Die Antwort enthält am Ende einen pagination-Block: total_records, total_pages, page_no, page_limit sowie Links zur nächsten und vorherigen Seite.

Welche Events werden zurückgegeben? (3)

• Nur Events mit publication_status = published.

• Interne Events und Events für eingeladene Kontakte werden nie zurückgegeben. In der Liste erscheinen nur öffentliche Events.

• Links (detail_url und die Anmelde-url) zeigen immer auf die Hauptdomain der Organisation.

  
  

Was enthält ein Event in der Liste? (4)

Wie beeinflussen die Einstellungen des Vereins die Liste? (5)

Vereine legen in den Einstellungen der Ausschreibung fest, was angezeigt wird. Die API richtet sich danach:

Wie werden Eintrittspreise in der Liste angezeigt? (6)

pricing_type ist single, free oder range. tickets_count hat in allen zutreffenden Fällen einen Wert.

• Bei free ist auch currency null.

• open_seats.count zeigt die noch verfügbaren Plätze, ausser der Verein blendet den Wert aus (siehe Abschnitt 5).

Was bedeutet der Anmeldestatus? (7)

Jedes Event in der Liste hat registration.subscription_status. Es verwendet dieselben Werte wie die Eventdetails:

Wie lade ich ein einzelnes Event? (8)

Für Entwickler. Senden Sie eine GET-Anfrage mit der Event-ID:

• GET /fsa/v2.0/event/{oid}/events/{eventId}

Die Details enthalten alles aus der Liste und zusätzlich:

• hierarchy.path und hierarchy.depth, die zeigen, wo das Event in der Eventhierarchie steht.

• responsible_persons: ID, Vor- und Nachname, Funktion, Mobilnummer und E-Mail.

• pricing.tickets: Name, Preis, Status, MWST-Satz und Kapazität (max_bookings, available_bookings, waiting_list_count). Deaktivierte Tickets werden weggelassen.

• pricing.resource_pricing: Zusatzleistungen, mit Preis, Beschreibung und MWST-Satz.

• registration: opens_at, closes_at, approval_required, waiting_list_enabled und subscription_status.

• Der neue Block announcement (siehe Abschnitt 10).

Tickets sind mit ticket_type gekennzeichnet:

Was kann ein Verein in den Eventdetails ausblenden? (9)

Die Einstellungen der Infobox und der Ankündigung steuern die Details. Ausgeblendete Felder behalten ihren Schlüssel und werden auf null gesetzt, wie in Abschnitt 5.

Was enthält der Block «announcement»? (10)

Der Block announcement enthält die Inhalte der Ausschreibungsseite des Vereins:

• media: in den Einstellungen der Ausschreibung hochgeladene Bilder.

• documents: in den Einstellungen der Ausschreibung hochgeladene Dokumente (ID, Name, Link, Typ).

• text_sections: vom Administrator hinzugefügte eigene Textabschnitte.

• contact: Kontaktangaben als Freitext.

•  

• info_box: der Anmeldestatus und vom Administrator definierte eigene Zeilen.

  
  

Wie lade ich Teilevents? (11)

Ergänzen Sie die Anfrage für die Details um expand=children. Mit depth legen Sie fest, wie viele Ebenen Sie möchten:

• GET /fsa/v2.0/event/{oid}/events/{eventId}?expand=children&depth=2

• Teilevents erscheinen in einer Liste children innerhalb des Events. Jedes hat die vollständige Struktur eines Events.

• Jedes Teilevent hat ihre eigene hierarchy (parent_id, root_id, path und depth).

• Sichtbarkeitseinstellungen, Veröffentlichungsregeln und Sprache gelten für Teilevents genauso.

• meta.expansion zeigt, was erweitert wurde, sowie die angeforderte und die gelieferte Tiefe.

• Ohne expand erhalten Sie nur has_children und children_count.

  
  

Welche Fehler können auftreten? (12)

Was sollte ich sonst noch wissen? (13)