WebAPI zur Auslastungsanzeige : Integration und Personalisierung

WebAPI zur Auslastungsanzeige : Integration und Personalisierung

Einleitung

Unter dem Begriff “WebAPI” verstehen wir einige Module, die in den Code einer Internetseite integriert werden, um folgende Informationen als Widget anzuzeigen :

  • Die Besucheranzahl der Einrichtung in Echtzeit (Auslastungsgrad oder Wartezeit)
  • Die Öffnungszeiten der Einrichtung

KB_API.JPG

Beispiel von einer API mit dem Auslastungsgrad und den aktualisierten Öffnungszeiten der Bibliothek (Quelle : Hochschulbibliothek Konstanz)

 

Alle WebAPIs aktualisieren sich automatischen jede 5 Minuten. Jedes WebAPI hat ein responsives Design: die API passt sich unterschiedlichen Elementen, die sie enthält, an und bietet so selbst für verschiedene Träger eine komfortable Nutzung.
Um die WebAPIs Ihrer Einrichtung wiederzufinden, gehen Sie auf das Verwaltungsportal "Besucherzahl senden".  Wenn Sie mehrere Räume haben, müssen Sie diese in dem Drop-Down-Menü auswählen, um an die jeweiligen APIs zu gelangen. 

Integration

HTML-Tags

Die WebAPIs bestehen aus HTML-Tags, die schnell und einfach in eine Internetseite integriert werden können. 

  • Ein <Skript>-Tag, um den JavaScript Code herunterzuladen, der für das Modul nötig ist.
    • Dieser Tag soll in den Seitencode zwischen den <head> Tags integriert werden. 
    • Es gibt einen <script> Tag für jede Art von Modulen, die angezeigt werden sollen (Belegungsgrad, Wartezeit, Öffnungszeiten). 
  • Ein Display-Tag der WebAPI, das sich je nach anzuzeigender Information (Wartezeit, Öffnungszeiten, Belegungsgrad) unterscheidet. 
    • Dieser Tag muss in dem Seitencode integriert sein, auf dem die WebAPI angezeigt werden soll.

Den Code, der in die HTML-Seite integriert werden soll, finden Sie für jede Einrichtung im Onlineportal unter “Verwaltung -> Besucherzahl senden (webAPI)”.

Die Integration von unseren webAPIs in eine App ist ebenfalls möglich, wenn die App eine Webview anzeigen kann (s. Informationsmaterial iOS oder Android).

Beispiel vom Code

Beispiel eines HTML-Codes für eine WebaPI zur Anzeige des Belegungsgrades: 


  1. <html>
  2.     <head>
  3.         <script charset="UTF-8" src="https://webapi.affluences.com/js/webapi_latest.min.js%22></script>
  4.     </head>
  5.     <body>
  6.         <div class="affluences-counter" data-token="TST0T0t0TT0TTT"></div>
  7.     </body>
  8.  </html>


Personalisierung

Die WebAPIs können durch Hinzufügen von Attributen in dem <div> Tag personalisiert werden. 

In dieser Tabelle finden Sie die unterschiedlichen Attribute und möglichen Werte.

WebAPI

Attribut

Mögliche Werte

Beschreibung

Öffnungszeiten

data-hide-navigation

true/false

Die Knöpfe zum Wechsel der Woche (links und rechts von den Wochentagen) können verdeckt werden.

days-number

ganze Zahl von 1 bis 7

Nur einige Wochentage werden angezeigt.

lang

eng, de, frz, it

Sprache ändern (Standard : französisch)

Besucherzahlen in Echtzeit (Belegungsgrad oder Wartezeit)

forecasts-count

ganze Zahl von 1 bis 5

Vorhersage in den nächsten Zeitfenstern anzeigen (1 bis 5 Zeitfenster möglich) (s. hier unten)

greyscale ou grayscale

true/false

Farben der Anzeige zu Graustufen wechseln

lang

de, en, frz,  it

Sprache ändern (Standard : französisch)

data-title-override

Zeichenkette

Name der Einrichtung in der WepAPI ändern (Standard : Hauptname in dem Onlineportal)

 

                              Beispiel von der Personalisierung einer WebAPI zur Anzeige der Wartezeit mit “forecast-count” und “grayscale”

KB_Wartezeit_1.JPG


 Kommunikation

Einige Ratschläge, um die WebAPIs richtig zu verwenden:
  1. Präsentieren Sie die WebAPIs (oder Widgets) Ihrem Webmaster
  2. Präzisieren Sie Ihren Besuchern, dass die Daten in Echtzeit angegeben sind
  3. Fügen Sie einen klaren Titel und eine Bildunterschrift ein, z.B.: "Aktuelle Wartezeit am Kartenverkauf / Aktueller Belegungsgrad der Räume".

    • Related Articles

    • Protokoll zur Einbindung von Zähldaten über Software-Konnektor

      Prinzip Die Affluences Lösung soll anpassungsfähig, einfach umsetzbar und intelligent sein. Unsere Vision ist es, eine einzigartige Verwaltungslösung anzubieten, die Daten aus mehreren Systemen zusammenfasst. Die Integration von existierenden ...

    • Verarbeitung personenbezogener Daten und Einhaltung der DSGVO

      Im Rahmen der Nutzung seiner Dienste kann Affluences personenbezogene Daten verarbeiten.  Affluences verpflichtet sich, diese Daten für rein operative und nicht kommerzielle Zwecke unter Einhaltung der geltenden Vorschriften (DSGVO) zu verarbeiten. ...

    • Technischer Fragebogen zur Installierung eines Software-Anschlusses

      Mit diesem Fragebogen unserer IT-Abteilung kann festgestellt werden, ob und wie eine Schnittstelle zwischen unserem Verwaltungssystem und Ihrer Messdaten eingerichtet werden kann. Abruf der Frequenz-Historie Besitzen Sie die folgenden Informationen ...

    • Verwaltung

      Unter der Kategorie “Verwaltung” können Sie die Informationen Ihrer Einrichtung einfach verwalten und bearbeiten.  Informationen verwalten In der Kategorie Informationen verwalten können Sie alle allgemeinen Informationen Ihrer Einrichtung angeben : ...

    • 3D-Videozähler - Technisches Datenblatt

      Präsentation Der 3D-Videozähler ist ein System, das die 3D-Videotechnologie nutzt.  Weit oben in Deckenhöhe angebracht zählt er alle Personen, die sich in seinem Aufzeichnungsbereich unterhalb seiner Position befinden.  Der Videozähler ist ein sehr ...