Inhalt

Dieser Login-Dienst dient der Anbindung eines Portals über die ExtensionAPI (z.B. Kommunalportal.NRW oder OpenR@thaus).

Schritt 1: Konfiguration anlegen

Um eine Verbindung via ExtensionAPI herzustellen ist nach dem Anlegen des entsprechenden Login-Dienstes hauptsächlich die Angabe der notwendigen Zertifikate und Signatur-Schlüssel notwendig:

Signaturschlüssel:

Geben Sie hier bitte den durch den Portal-Betreiber zur Verfügung gestellten Signaturschlüssel an.

Zertifikat:

Geben Sie hier bitte den Zertifikatsspeicher den Sie vom Betreiber des Portals bereitgestellt bekommen an. Sollte mit dem Portal ferner über eine gesicherte Verbindung kommuniziert werden und hierfür ein standardmäßig nicht vertrauenswürdiges Zertifikat benutzt werden, kann dieses diesem Speicher hinzugefügt werden.

Zertifikatsdaten - Passwort:

Geben Sie hier das Passwort für den Zertifikatsspeicher an. Dieses sollte Ihnen ebenso der Portal-Betreiber mitgeteilt haben.

Zertifikatsdaten - Alias:

Geben Sie hier den Alias des Zertifikats an, welches für die Signatur bzw. Verschlüsselung für Nachrichten an bzw. vom Portal benutzt werden soll. Diese Information sollte Ihnen ebenso der Portal-Betreiber mitteilen. Alternativ können Sie den Alias auch ermitteln, indem Sie diesen durch das Öffnen des Zertifikatsspeichers selbstständig ermitteln.

Nach der Eingabe der entsprechenden Daten können Sie diese durch Speichern verifizieren. Sind die hochgeladenen Dateien unter Verwendung der angegebenen Informationen lesbar, gelangen Sie zum nächsten Schritt. Sollte dies nicht der Fall sein, erhalten Sie eine entsprechende Fehlermeldung.

Schritt 2: Verbindung herstellen

Nach dem erfolgreichen Speichern und Validieren der initialen Daten öffnet sich die Oberfläche für Schritt 2. Hier werden Ihnen die URL für die Anbindung der ExtensionAPI sowie das im Portal zu hinterlegende Zertifikat angezeigt. Konfigurieren Sie demnach Ihre Extension im entsprechenden Portal unter Verwendung dieser Informationen. Beim Speichern sollte das Portal eine Anfrage an formcycle senden, die dazu führt, dass die Konfiguration abgeschlossen wird und sich die Oberfläche des Login-Dienstes nach einer Aktualisierung wie in Schritt 3 darstellt.

Hinweis:
Wenn mehrere URLs angezeigt werden, ist die zu wählen, die aus dem Internet erreichbar ist, also zum Beispiel die URL des Frontend-Servers. 

Wenn der ExtensionAPI-Authentikator auf Systemebene eingerichtet wird, werden aktuell die URLs der Frontend-Server nicht mit angezeigt. Dies wird in einer zukünftigen Version des Bürgerservice-Plugins behoben werden. 

In der Zwischenzeit kann der im Portal zu hinterlegende Link per Hand zusammengebaut werden, indem der Teil der URL ab /portal an die Basis-URL des Frontend-Servers angehangen wird. Eine Basis-URL https://formulare.beispiel.de/frontend-server und ein an der Oberfläche sichtbarer Extension-Link https://master.organisation.local/formcycle/portal/extensionapi/endpoint/12345678-90ab-cdef-1234-567890abcdef müsste also zu https://formulare.beispiel.de/frontend-server/portal/extensionapi/endpoint/12345678-90ab-cdef-1234-567890abcdef zusammengesetzt und im Portal eingetragen werden.

Schritt 3: Verbindung erfolgreich hergestellt

Nach erfolgreicher Konfiguration stellt sich die Oberfläche des Login-Dienstes wie oben erkennbar dar. Hier haben Sie jederzeit die Möglichkeit die hinterlegten Daten zu aktualisieren bzw. auszutauschen. Ferner können Sie über die Schaltfläche Portal-Daten aktualisieren die Synchronisation zwischen formcycle und dem angebundenen Portal ausführen.

Hinweis:
Nach erfolgter Konfiguration von Login-Diensten oder Sichtbarkeiten an einem Formular (siehe Bürgerservices-Plugin) muss dies dem Portal über die ExtensionAPI aktiv mitgeteilt werden. Hierfür können Sie entweder die Funktionalität des Portals verwenden oder die oben beschriebene Synchronisation ausführen.