Integration XNP - Notariatssoftware

XNP bietet die Möglichkeit, bestimmte Funktionen automatisiert aus anderen Anwendungen (bspw. Notariatssoftware) direkt und ohne weitere Nutzerinteraktion aufrufen zu können. 

Stand Oktober 2025 werden folgende Funktionen angeboten:

• Generell:
  • Auslösen eines Logins mit Karte oder Nutzername (in XNP)
• UVZ:
  • Suche nach UVZ-Einträgen
  • Abfrage eines UVZ-Eintrages
  • Ermittlung der nächsten (freien) UVZ-Nummer
  • Erstellen von UVZ-Einträgen
  • Hinzufügen von Dokumenten zu bestehenden UVZ-Einträgen
• VVZ:
  • Suche nach Verwahrungsmassen
  • Abfrage einer Verwahrungsmasse
  • Erstellen von Verwahrungsmassen

XNP stellt eine Funktion bereit, die innerhalb von XNP eine so genannte Web-Service-Schnittstelle zum lokalen Aufruf anbietet (REST-Endpunkt). Zum Anbieten des REST-Endpunktes wird ein lokaler Webserver gestartet. Dieser Webserver wird nur auf dem lokalen Pseudointerface (localhost) gestartet, so dass nur vom lokalen Rechner aus eine Kommunikation mit dieser Schnittstelle möglich ist. 

Mit Wartungsupdate am 29.10.2025 wird diese Funktion standardmäßig bei allen Nutzern aktiviert. 

Eine Abwahl der Funktion ist individuell möglich (opt-out). Ebenso ist eine individuelle Anpassung der Schnittstelle möglich.

Sofern keine individuelle Konfiguration vorgenommen worden ist, versucht XNP den Webserver an den ersten freien Port beginnend bei 12774 und endend bei 12784 auf localhost zu binden. Gelingt dies nicht (weil bspw. kein freier Port gefunden werden konnte, oder dies administrativ untersagt worden ist), startet XNP trotzdem, meldet jedoch, dass diese Funktion inaktiv ist. 

Gelingt das Binden des Ports so wird der gefundene Port in die lokale Konfigurationsdatei geschrieben, so dass dieser Port bei allen weiteren Anwendungsstarts erneut benutzt wird. 

Die lokale Konfiguraitonsdatei befindet sich im XNP-Anwendungsverzeichnis (ehemals LSP-Home, jetzt: XNP_HOME_CONFIG; üblicherweise in %APPDATA%\XNP) in “Configuration\@xna/main.yml”. 

Die Einträge für die Schnittstelle finden sich im Abschnitt “xjab”:

    sharedStoragePath: X:\XNP\doccache
         xjab:
      port: 12774
      encryptedApiKeys: {}
      disabledByUser: false
 

Ist die Schnittstelle aktiv, kann eine Notariatssoftware (NSW) über eine durch die BNotK veröffentlichte Schnittstellendefinition auf diese XNP-Schnittstelle zugreifen und die Funktionen ausführen. 

In der Regel müssen die Nutzenden hierfür ganz normal in XNP angemeldet sein. Die NSW muss in der Schnittstelle die Anmeldeinformationen (ein so genanntes Login-Token) sowie die aktuelle Amtstätigkeit für die der Aufruf stattfindet übergeben. XNP überprüft, ob die übergebenen Informationen zur aktuellen Anmeldung innerhalb von XNP zum Nutzenden passen und entscheidet sodann über die weitere Ausführbarkeit. 

Die aufrufende NSW benötigt somit immer Login-Informationen. Diese kann die NSW entweder über einen ebenfalls bereitgestellten und kommunizierten Mechanismus mit den Systemen der BNotK auf Basis von konkreten Anmeldeinformationen des Nutzers erstellen oder alternativ auch eine spezielle Funktion der XNP-Schnittstelle zum Login aufrufen. Mit letzterer ist es auch möglich, eine Anmeldung mit Karte durchführen zu lassen, sofern der Nutzende noch nicht angemeldet ist. 
Für diese spezielle XNP-Schnittstellen-Funktion des Logins ist es notwendig, dass sich XNP und NSW gegenseitig vertrauen. Dieses Vertrauen wird durch einen speziellen Schlüssel in der Anwendung gewährleistet - den so genannten “API-Key”. Dieser ist nur für den Aufruf der Login-Funktion aus Sicherheitsgründen notwendig. Dieser Schlüssel muss von jedem Nutzer selbständig in der Konfiguration (siehe unten) hinterlegt werden. Dieser API-Key wird verschlüsselt in der Konfigurationsdatei gespeichert und ist in verschlüsselter Form nicht zwischen unterschiedlichen Installationen von XNP übertragbar. 

Sofern die NSW jedoch anderweitig die Login-Informationen beziehen kann, bleibt die Konfiguration des API-Keys rein optional. 

Um die XNP-NSW-API ansprechen und nutzen zu können, muss ein Anwender keine zusätzliche Einstellung mehr vornehmen. Er kann jedoch Einfluss auf die Konfiguration nehmen, um diese bspw. an einen anderen TCP Port zu binden oder die Schnittstelle zu inaktivieren. 

Wie beschrieben wird die Konfiguration pro Installation (also pro Windows-User) vorgenommen und gilt dann unabhängig davon, welcher Nutzer innerhalb von XNP angemeldet wird. 

Zur Individualisierung durch den Nutzer geht dieser wie folgt vor:

1. Anmeldung in XNP
2. Öffnen der Einstellungen über das Benutzermenü oben rechts
3. Öffnen der Benutzereinstellungen “Meine Einstellungen (Nutzer)”
4. Auswahl der Plattform-Einstelungen (Reiter: “Plattform”)
5. Öffnen der Notariatssoftware-Schnittstellen-Konfiguration

• Über die Checkbox “Notariatssoftware-Schnittstelle aktiv" kann die Schnittstelle aktiviert bzw. inaktiviert werden
  • für das Wirksamwerden der Änderung ist ein Neustart von XNP notwendig
• Im Eingabefeld “Port” kann ein numerischer TCP Port angegeben werden, den die Schnittstelle nutzen soll, um ihre Funktionen wie oben geschildert anzubieten.
• mittels “Validieren” kann überprüft werden, ob der angegbene TCP-Port genutzt werden kann.
• Im Bereich API-Keys können über die Schaltfläche “+ API-Key hinzufügen” beliebig viele API-Keys für NSWs hinterlegt werden. Beim Anlegen eines API-Keys wird ein zufälliger Schlüssel von XNP erzeugt. Der Nutzende hat die Wahl diesen zu ändern. Zusätzlich zum API-Key selbst muss der Nutzer einen kurzen Namen der Software angeben, die ihn verwendet. Dieser Name hat keinerlei weitere Bedeutung, erscheint ggf. aber in den Log-Dateien.