Anwender
HilfeChangelogAdministratoren
Einrichtung BundIDWidget erstellenCSV-Mitarbeiter-ImportAnbindung Active DirectoryAnbindung d.velop documentsAnbindung Exchange ServerDienstleister
Webseiten-WidgetSuch- und GraphQL-APIPartner
Anbindung DMSAnbindung FormularserverOAuth2.0Einleitung
optiGov bietet zur Einbindung von Funktionalitäten, wie dem Darstellen von Dienstleistungen, Einrichtungen, Mitarbeitern, der Authentifizierung des Bürgers, dem Einreichen von Anträgen, dem sicheren Nachrichtenaustausch, uvm. nicht nur eine GraphQL-Schnittstelle an, sondern auch ein JavaScript-Widget. Dieses Widget handhabt bereits die relevante Kommunikation zu der Schnittstelle und generiert automatisch eine responsive und barrierefreie Darstellung.
Dabei erfolgt die Pflege und Weiterentwicklung des JavaScript-Widgets durch die optiGov GmbH. Anpassungen am Stil oder der Funktionalität sind durch CSS und JavaScript der jeweiligen Webseitenintegration überlassen.
Tipp: Passend zu dem JavaScript-Widget wird ebenfalls ein minimaler standartisierter und allgemeiner Style als CSS-Datei ausgelifert. Wir empfehlen diesen als Grundlage, oder sogar unverändert zu verwenden, um Arbeit bei der Anbindung zu sparen. Weitere Informationen dazu finden Sie unter CSS Einbindung und Anpassungen.
Referenz-Implementation
Hier finden Sie eine Referenzimplemention, angebunden an die Demo-Installation von optiGov. Diese enthält einen optigov Ordner, welchen Sie so auf einer Website platzieren können.
Um den Code zu testen, empfehlen wir einen Apache-Web-Server zu verwenden und die Domain localhost auf das Basis-Verzeichnis (in welchem der Ordner /optigov liegt) zeigen zu lassen.
Bitte werfen Sie auch bei Verwendung der Referenz-Implementation immer einen Blick in die Anbindung:
Häufige Fragen und Fehler
Falls Sie ein Problem bei der Anbindung haben ist es sehr wahrscheinlich, dass bereits ein Dienstleister vor Ihnen über die Problematik gestolpert ist.
Daher sammeln wir hier die häufigsten Fragen und Fehler:
Vermutlich haben Sie die das Widget unter einer anderen URL als /optigov abgelegt. Dies ist an sich kein Problem, es muss nur bedacht werden, dass in der Konfiguration des Widgets diese URLs dann auch hinterlegt werden, da sonst keine Inhalte geladen werden können (s. Anbindung).
Client-Authentication FailedTritt ein Fehler wie der folgende auf, bedeutet dies, dass der OAuth-Client der angebundenen Instanz auf dieser oder im Widget nicht korrekt konfiguriert ist.
Zum Lösen des Problems gilt grundsätzlich folgendes zu Prüfen:
Korrekte Login-URL
Ist die korrekte Login-URL hinterlegt? Im Falle der Beispiel-Website optistadt.de ist dies nicht mit https://optistadt.de/de/buerger-service sondern https://optistadt.de/de/buerger-service/login gegeben. Diese URLs hängen von dem Installationsort ab, enden i.d.R. (sofern nicht durch den Website-Dienstleister abgeändert) auf „/login“ und müssen durch einen Administrator der Instanz (oder die optiGov GmbH) einmalig konfiguriert werden.
Korrekte Client-ID
Ist die korrekte Client-ID im Widget konfiguriert? Im Backend von optiGov finden Sie auf der rechten Seite der Detailansicht eines OAuth2.0-Mandanten diese Information.
Landen Sie auf der o.g. Fehlerseite (s. Screenshot) ist an der URL der Fehlerseite zu erkennen, ob diese Unstimmigkeit auch zutrifft. So wurde z.B. durch den Website-Dienstleister eine falsche ID angegeben. In der URL steht hier im Parameter client_id=1. I.d.R. ist für die Website-Anbindungen aber die ID 2 vorgesehen, falls dies nicht nicht im Backend geändert wurde.
Es fehlt vermutlich die .htaccess-Datei die die Umleitung nicht vorhandener URLs auf die index.html-Seite umsetzt. Ohne diese „existieren“ die jeweiligen URLs nicht (und somit auch nicht die Login-URL). Dies führt dazu, dass man auf einer 404-Seite landet.