Benutzer-Werkzeuge

Webseiten-Werkzeuge


schnittstellen

Schnittstellen

Die Integreat-App verfügt über Schnittstellen in zwei Richtungen. Eine eingehende Schnittstelle und eine ausgehende Schnittstelle. Eine Schnittstelle ist ein Dienst, der einen Datenfluss bereitstellt. Der Datenfluss erfolgt ohne Layout/Gestaltung in einem strukturierten Format. Die Schnittstellen bei Integreat bedienen sich am JSON-Format.

Die „Richtung“ definiert dabei den Fall, wo die Daten erfasst und übersetzt werden und wohin sie danach geschickt werden. Sollen Daten also im Integreat-System erstellt und übersetzt und dann anderswo genutzt werden, ist dafür die ausgehende Schnittstelle notwendig. Sollen Daten in einem externen (z.B. städtischen EDV-System) gepflegt und übersetzt werden und im Anschluss auch in der Integreat-App auftauchen, geht dies über die eingehende Schnittstelle.

Im Folgenden erklären wir beide Schnittstellen ausführlicher.

Ausgehende Schnittstelle

Der direkte Link zur Schnittstelle, die ohne Zugangsdaten genutzt werden kann, lautet: https://admin.integreat-app.de/api/KOMMUNENID/de/pages/

Die KOMMUNENID ist der eindeutige Bezeichner, den Sie auch nach dem Aufruf Ihrer Integreat-App per Webbrowser in der URL-Zeile sehen. Über das Sprachkürzel in der Schnittstellen-URL kann gesteuert werden für welche Sprache die Schnittstelle Daten liefern soll. Die ausgehende Schnittstelle ist ein reiner Datenfluss ohne Layout, d.h. es muss sich um eine geeignete Visualisierung im Zielsystem gekümmert werden.

Eine Alternative dazu ohne Programmier-Aufwand stellen die Verlinkung („Klassiker“) oder das Einbetten als iFrame dar.

Eingehende Schnittstelle

Externe Informationen können ebenfalls auch (andersherum) in unser Integreat-System geschoben werden. Dazu haben wir ebenfalls eine offene Schnittstelle entwickelt, mit der Sie Ihre Daten unserem System zuliefern können. Das geschieht in Integreat z.B. auch mit den Daten des Robert-Koch-Instituts (RKI), die uns ihre 7-Tages-Inzidenzen jede Stunde zuliefern. Die Inhalte müssen dann in den verschiedenen Sprachen vom externen System bereitgestellt werden. Im Integreat-System müssen dann nur die Seiten mit Überschrift (das Inhaltsfeld kann leer bleiben) angelegt werden und ein sogenanntes Token hinterlegt werden (quasi ein 16-20 Zeichen langes Passwort), dass vom externen System mitgeschickt wird, um die Seite richtig zuordnen zu können. Das Management der Übersetzungen etc. erfolgt dann ebenfalls im externen System und die Integreat-App liest quasi nur mit und synchronisiert alles.

Endpoints & Dokumentation

Die Integreat-App verfügt über 4 Datenobjekte, die über eine Schnittstelle sinnvoll bereitgestellt werden können:

  • Seiten (das sind die Objekte wo die Texte/Inhalte drinstehen)
  • Veranstaltungen
  • Nachrichten
  • POIs (das sind die Orte auf der Karte)

Die ausgehende Schnittstelle existiert bereits für alle 4 Datenobjekte, d.h. alle unsere Datenobjekte können in externen Systemen genutzt bzw. eingebettet werden.

Die eingehende Schnittstelle existiert bei nur für Seiten, d.h. noch nicht für Nachrichten, Veranstaltungen und POIs.

Bei beiden Richtungen gilt: Je nachdem wie die Schnittstelle eingebunden werden sollen bzw. welche Daten an die Integreat-App geschickt werden sollen, braucht es IT-Expert:innen die sich mit dem kommunalen EDV-System auskennen und wissen wo und wie die Umsetzung bei im System Sinn macht.

schnittstellen.txt · Zuletzt geändert: 2022/09/15 17:12 von daniel.kehne