1. Support
  2. APIs & Entwickler Doku

Auslastung auf eigener Homepage anzeigen

Anzeige einrichten

 

  1. Fordern Sie einen API-Schlüssel für Ihren Standort bei support@connfair.com an.*
  2. Die API’s können auf zwei Arten in Ihre Homepage integriert werden.

    1. technisch über einen konfigurierten iFrame:


    2. kundenindividuell über REST API wie z.B. hier im Freibad Mering:

 

*Hinweis:

Geben Sie bei der Anfrage den vollqualifizierten Domänennamen (=Hostname) und den Einlass-Standort an, für den die Integration erforderlich ist. Die Integration funktioniert nicht ohne das Domänen-Whitelisting. Das heißt, die API muss von Ihrer Webseite als vertrauenswürdige Quelle eingestuft sein.

 

Integration via iFrame

Konfiguration des iFrames

Einige Parameter der Auslastungsanzeige können Sie mit der Option iFrame über den HTML-Code individualisieren. Dazu zählen Sprache, Überschrift, Größe, Auslastungsansicht.

Eine Übersicht der Konfigurationsoptionen über Abfrageparameter:

 

Parameter

Konfiguration

Kommentar

OBLIGATORISCH    
apiKey Individueller API-Schlüssel Parameter notwendig, ansonsten Fehleranzeige
eventId Identifikation des Einlass-Standorts Parameter notwendig, ansonsten Fehleranzeige
language Sprache Untersützt derzeit de und en; automatisch en wenn nicht angegeben
OPTIONAL    
hideHeadline Kann Überschrift ausblenden true, um Überschrift auszublenden, standardmäßig wird Überschrift angezeigt
size Einstellung der Schriftgröße Standardwert: 40
displayType Änderung der Auslastungsansicht in Prozent Mögliche Konfiguration percentage oder percentageWithTotalCount 

Eine Beispiel-URL sehen Sie hier: https://cfcs.iframes.connfair.com/?eventId=59443249-a3df-4695-9e15-2d396885b4ce&apiKey=dbfd0744-a82f-11ea-a756-42010a840121&language=de&size=40

Integration via REST API 

  • Via API können Sie die Auslastungsanzeige frei nach Ihren eigenen Wünschen einrichten.
  • URL für die Abfrage: https://api.connfair.com/cf/api/v1/apiKey/events/{eventId}/cfcs/currentValue?apiKey={apiKey} (eventId und apiKey müssen ersetzt werden)
  • Die Antwort erfolgt im JSON-Format:
  • Parameter

    Bedeutung

    eventId Identifikation des Einlass-Standorts
    currentValue Aktuelle Auslastung
    maxPeopleCount Aktuell erlaubte Anzahl an Persone
  • HTTP Header origin muss auf den freigegebenen Hostname gesetzt sein. Dies ist Standardverhalten von Browsern. Bei serverseitiger Implementierung muss der Header manuell gesetzt werden.

Fehlerbehebung iFrame & REST API

Ein Fehler wird angezeigt, wenn ...
  • ...apiKey oder eventId ungültig sind
  • ...der Domänenname für apiKey und eventId nicht aktiviert ist

Support

Wenden Sie sich für technische Unterstützung an support@connfair.com.