Plugin Setup

Inhalt [ Verbergen ]

Vertragliche Voraussetzungen

Damit das ePayment der AKDB in FORMCYCLE eingerichtet werden kann, muss zuvor ein Vertrag mit der AKDB geschlossen werden. Der Antrag kann dabei formlos von der AKDB, über die Mail-Adresse BayernID@akdb.de, angefordert werden. Dabei sollte angegebenen werden, ob das Test- oder Live-ePayment-System der AKDB angebunden werden soll.

Ist bereits ein Vertrag über das ePayment mit der AKDB vorhanden, so kann dieser herangezogen werden und mit dem Schritt der Initialen Installation fortgesetzt werden.

Initiale Installation

AKDB ePay Setup - Schritt 1

Voraussetzungen

  • Es wurde ein Vertrag über das ePayment mit der AKDB geschlossen und die notwendigen Daten (AKDB-EPayment-Mandant) liegen vor.
  • Bei Anbindung des ePayment Live-Systems muss zusätzlich ein Zertifikat für den Zugriff auf den Payment-Webservice von der AKDB vorhanden sein.
    • Sollte bereits das Live-System vom AKDB Bürgerkonto-Service / Postkorb angebunden sein, so kann dieses Zertifikat für den Zugriff verwendet werden.
    • Ist der vorherige Punkt nicht gegeben, so muss dies explizit bei der AKDB angefordert werden.
  • Das Plugin-Bundle plugin-bundle-akdb-epayment.jar ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version.

Installationsschritte

  • Anmeldung als sadmin am FORMCYCLE-System.
  • Wechsel in den FORMCYCLE-Mandanten, welcher eine Anbindung an das AKDB-Bürgerkonto erhalten soll.
    Sollte ein Auswahl des Mandanten nicht möglich sein, dann muss dies als Mandant-Administrator noch freigebeben werden. Die Einstellung finden Sie unter Mandant > Einstellungen.
  • Registrierung des plugin-bundle-akdb-epayment.jar Plugins im Bereich des FROMCYCLE-Mandanten (Menüpunkt: Mandant > Plugins).
  • Jetzt ist ein neuer Menüpunkt AKDB ePay Setup vorhanden, welcher aufgerufen werden muss.
    Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin mit Wechsel in den Mandanten notwendig.
  • Beim Aufruf des Setups muss jetzt der Punkt Zur Anbindung ePay-BL Umgebung ausgeführt werden.
    Zu Beginn müssen Sie sich entscheiden, ob Sie die Test- oder Liveumgebung des AKDB EPayment Dienstes anbinden möchen. Liegt ein Vertrag bereits vor, so können auch alle weiteren Daten zum AKDB ePayment Mandanten hinterlegt und gespeichert werden.
  • Nach dem Speichern werden die Daten in den Properties des Plugins entsprechend hinterlegt.
Hinweise zur Erreichbarkeit notwendiger System-URLs

Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).

Folgende URL(s) müssen von Extern erreichbar sein, damit eine Rückmeldung vom ePay-BL-Portal korrekt verarbeitet werden kann:

  • https://<Domain-Adresse des Master-Servers>/formcycle/plugin (Master-Server)
    ODER
  • https://<Domain-Adresse des Frontend-Servers>/frontend-server/plugin (Frontend-Server)

Folgende URL muss vom FORMCYCLE Master-Server aus erreichbar sein:

  • Testsystem: https://infra-pre.buergerserviceportal.de/soap/servlet/rpcrouter
    ODER
  • Livesystem: https://buergerserviceportal.de/soap/servlet/rpcrouter

Damit ist der 1. Schritt der Einrichtung abgeschlossen. Bei Anbindung des Testsystem ist die Einrichtung hiermit abgeschlossen.

AKDB ePay Setup - Schritt 2

Vorbedingungen

  • Dieser Installationsschritt muss nur ausgeführt werden, wenn das ePayment Live-System angebunden werden soll.
  • Bei Anbindung des ePayment Test-Systems ist kein Zugriffs-Zertifikat notwendig und kann deshalb auch nicht hinterlegt werden.

Installationsschritte

  • Aufruf des Menüpunkt AKDB ePay Setup und dort Zur Zertifikats-Registrierung und Verbindungsprüfung ausführen.
  • Das von der AKDB erhaltene Zertifikat muss hochgeladen und das Zertifikats-Passwort hinterlegt werden.
  • Anschließend kann der Button Prüfen und Speichern geklickt werden.
    Damit wird das Zertifikat im System gespeichert und an den Plugin-Einstellungen registriert.
    Weiterhin wird versucht mit dem hinterlegten Passwort auf das Zertifikat zuzugreifen und bei Erfolg wird das Gültigkeitsdatum des Zertifikats angezeigt.
  • Mit dem Button Verbindung zu ePay-BL prüfen kann jetzt testweise eine Verbindungsprüfung stattfinden. Dabei wird ebenfalls im Vorfeld eine Zertifikatsprüfung durchgeführt.
    Wenn der ePayment-Webservice nicht erreicht werden kann, so sind gegebenenfalls Firewall-Einstellungen zu prüfen. Die konkrete URL zum Webservice wird dabei in der Fehlermeldung angezeigt. Der Aufbau der Webservice-Verbindung muss dabei vom FORMCYCLE Master-Server oder Frontend-Server aus möglich sein (siehe Hinweis oben).
    Hinweis: Für eine vollständige Prüfung des Webservice-Zugriffs muss im Vorfeld die EPayment-MandantNr konfiguriert sein. Ansonst findet an dieser Stelle nur eine generelle Verbindungsprüfung statt.

Damit ist die Konfiguration abgeschlossen.

Anpassungen zum späteren Zeitpunkt

Aktualisierung des Zugriffszertifikats für den AKDB ePayment LIVE-Service

Vorbedingung

Sie haben ein neues Zertifikat für den Zugriff auf den AKDB-ePayment Webservice erhalten, da ihr altes Zertifikat abgelaufen ist

Vorgehen

Folgen Sie der Anleitung unter dem Punkt AKDB ePay Setup - Schritt 2: Installationsschritte und aktualisieren Sie ihr Zertifikat.