Portalintegration

Allgemeines

Um einen Antragsassistnten in ein Portal einzubinden, stellt Form-Solutions mehrere Möglichkeiten bereit. Hierbei werden unterschiedliche Konfigurationsmöglichkeiten angeboten, um den Bezug zum entsprechenden Portal aufrecht zu erhalten.

Eingebetteter Modus

Ein beliebiger Vorschau- oder Veröffentlichungslink eines Assistenten kann um den URL-Parameter embedded=true ergänzt werden, um eine reduzierte Darstellung zu veranlassen. Diese lässt sich optisch besser per Iframe in eine Rahmenumgebung integrieren. Dabei entfallen die Darstellung der Logos, sowie der Fußzeile mit Impressum und Datenschutzerklärung.

***Hinweis:***
Das Logo und die Fußzeile mit Impressum, Datenschutzerklärung und Erklärung zur Barrierefreiheit müssen von der Rahmenseite bereitgestellt werden.

Beispiele:

https://vertrieb.form-solutions.de/metaform/Form-Solutions/?oID=22222222-2222&assistant=AS_940000&version=26&userId=77777777-0000-0001&releaseOrganizationID=77777777-0000&embedded=true

https://vertrieb.form-solutions.de/metaform/FormSolutions/sid/assistant/\<SID\>?embedded=true

Rücksprung-URLs

Soll nach dem Ausfüllen oder beim Abbruch eines Assistenten wieder direkt ins Portal gesprungen werden, können beim Aufruf verschiedene Rücksprung-URLs über die von Form-Solutions bereitgestellten Schnittstellen z.B. Postdata mitgegeben werden.

• successUrl
  Nach erfolgreicher Einreichung wird auf diese URL weitergeleitet. Beispiel: https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5b9b53dad5de93019b42df8c?successrUrl=https://www.testurl.de

***Achtung:***
Dieser Parameter kann auch über die Postdata Schnittstelle mitgegeben werden.

• cancelUrl
  Bricht der Anwender den Ausfüllvorgang mit einem Klick auf Abbruch ab, wird er anschließend auf diese URL weitergeleitet. Beispiel: https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5b9b53dad5de93019b42df8c?cancelUrl=https://www.testurl.de

***Achtung:***
Dieser Parameter kann auch über die Postdata Schnittstelle mitgegeben werden.

• errorUrl
  Tritt während des Ausfüllvorgangs oder beim Einreichen ein technischer Fehler auf, wird der Anwender auf diese URL weitergeleitet. Beispiel: https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5b9b53dad5de93019b42df8c?errorUrl=https://www.testurl.de

***Achtung:***
Dieser Parameter kann auch über die Postdata Schnittstelle mitgegeben werden.

Übergabe von eID-Daten aus dem Portal

Bei Verwendung der zweistufigen Vorbefüllung können eID-Daten des Portals für den Anwender unveränderbar an den Ausfüllassistenten übergeben werden. Dazu müssen die Daten in folgende XML-Struktur überführt werden:

Sollten nicht alle Daten vorliegen, können die leeren Elemente weggelassen werden. Anschließend wird das gesamte XML base64-kodiert und als Parameter externalEIDData übergeben. Dies hat zur Folge, dass die Daten zum Teil zur Vorbefüllung herangezogen werden und dass diese unmanipulierbar zur Einreichung durchgeschleust werden. Dies lässt sich nach der Einreichung direkt am befüllten/erzeugten PDF und am Inbox-Eintrag am NPA-Logo erkennen.

Zwischenspeichern bei eingebetteter Darstellung

Wird ein Assistent im IFrame dargestellt und zwischengespeichert, so wird der Assistent beim Fortsetzen des Ausfüllvorgangs nicht innerhalb eines IFrames, sondern eigenständig gestartet. Dieses Verhalten kann mit der Hilfe einer restartURL verhindert werden. Wird beim eingebetteten Start des Assistenten eine solche restartURL mitgegeben, so werden beim Fortsetzen zuerst die zwischengespeicherten Daten an unseren Cache übergeben und anschließend an die restartURL weitergeleitet. Zusätzlich wird die restartURL um einen Parameter contentURL ergänzt. Die einbettende Seite kann dann diese contentURL für den IFrame verwenden, um den Ausfüllvorgang fortzusetzen.

Benachrichtigung bei Formulareinreichung

Soll ein Portal bei einer Formulareinreichung informiert werden, um z.B. einen eigenen Posteingang zu aktualisieren, kann beim Start eines Assistenten eine notifyUrl übergeben werden. Bei einer erfolgreichen Einreichung wird an diese URL ein POST gesendet. Der Inhalt des POST entspricht einer URL der Rest-API, unter welcher die eingegangenen Daten u.a. abgerufen werden können. Zusätzlich wird an die notifyUrl ein Parameter transactionId mit der Vorgangsnummer angehängt.

Nutzung der eID-Integration im Portal (experimentell)

Die Integration der verschiedenen eID-Anbieter in ein Portal kann über eine vereinheitlichte Form-Solutions-Schnittstelle erfolgen.

Dazu wird in einem ersten Schritt die Redirect-URL als request-Body an die folgende URL übergeben: [https://pdf.form-solutions.net/administrationCenter/Form-Solutions/<Kundenummer>/api/cache]
Als Rückgabewert erhalten Sie eine cacheId, die Sie im Folgeschritt als Parameter redirectID mitgeben.

Für den Aufruf der Cache-Schnittstelle ist eine Basic-Authentifizierung notwendig. Die entsprechenden Daten erhalten Sie nach Rücksprache.

Für den Start des EID-Prozesses wird der Anwender auf eine URL nach folgendem Muster weitergeleitet:

https://vertrieb.form-solutions.de/administrationCenter/Form-Solutions/\<Kundennummer\>/eID/eIDMandatory?redirectID=\<redirectID\>

Für die gewählte Kundennnummer muss dabei im Form-Solutions-System eine eID-Konfiguration hinterlegt sein. Nach dem Erfragen der eID-Daten wird der Anwender an die übergebene URL  weitergeleitet. Dabei wird dieser um den zusätzlichen Parameter eIDCacheID ergänzt. Mit dem Wert dieses Parameters können nun die eID-Daten im XML-Format (siehe "Übergabe von eID-Daten aus dem Portal) abgerufen werden. Die dazugehörige URL entspricht folgendem Muster:

https://vertrieb.form-solutions.de/administrationCenter/Form-Solutions/\<Kundennummer\>/eID/retrieve/\<eIDCacheID\>

***Hinweis:***
Die eIDCacheID ist nur einmalig gültig. D.h. die Daten werden direkt nach dem Abruf auf dem Form-Solutions-System verworfen.