Was sind die Webservices?
Neben der Nutzung des Redaktionsbereichs zur Datenpflege und Einbindung der Daten in Ihren kommunalen Auftritt über den Include-Wizard beinhaltet der BUS Webservice-Schnittstelle für komplexere Anwendungsszenarien.
Grundsätzlich existieren folgende Einbindungsvarianten zur Verfügung:
SOAP-WS (lesend oder lesend und schreibend)
REST-API
XZuFi-WS
Einbindungsassistent (Include-Wizard)
Include-Wizard
Definition von Abfragen und Ausgabe-Darstellungen in einem grafisch orientierten Editor
sehr flexibel an eigene Bedürfnisse anpassbar
verschiedene Einbindungsmöglichkeiten (Serverseitig und Client/Browserseitig)
Echtzeitschnittstelle
Schnittstelle für rein lesende Verwendung
keine Zertifizierung erforderlich
nach der Umsetzung geringer Pflegeaufwand
SOAP-WS (lesend oder lesend und schreibend)
Schnittstelle für lesende, optional auch schreibende Verwendung
höchste Flexibilität aber auch Komplexität
(fast) alle Daten abrufbar - keine Echtzeitschnittstelle
Zugriffsschutz über API-Key
Schnittstelle wird permanent weiterentwickelt, somit auch Pflege der Schnittstelle notwendig; Pflegeaufwand nach Umsetzung ist einzuplanen
komplexer SOAP-Service
technische Dokumentation online https://ws-st.zfinder.de/doc/
Zertifizierung erforderlich
Aufwand in der Regel erst ab Einsatz in mind. 3 Kommunen wirtschaftlich
REST-API
einfache REST-API
alle wichtigen Daten abrufbar
Echtzeitschnittstelle
Schnittstelle für lesende Verwendung
Dokumentation online restapi-v[Versionsnummer]-st.zfinder.de/doc/index.html (z.B. (z.B.: https://restapi-v2-st.zfinder.de/doc/index.html)
Zertifizierung erforderlich
Zugriffsschutz über API-Key
XZuFi-WS
Schnittstelle für lesende Verwendung via SOAP
der Standard XZuFi (XZuständigkeitsfinder) wird durch Teleport modelliert - alle Daten abrufbar
Nachrichten im Antwort/Request-Schema
Nachrichten zum Transfer großer Datenmengen
Ideal um Datenbestände zwischen Systemen zu synchronisieren
perspektivisch schreibend
Zertifizierung erforderlich
Was sind die Voraussetzungen zur Nutzung?
Zur Nutzung der Webservices ist eine Beantragung einer Zugangskennung beim notwendig.
Weiterhin muss Ihr verwendetes System für die Nutzung der Webservices zertifiziert sein. Es gibt derzeit bereits eine Reihe zertifizierte Produkte bzw. Lösungen. Weitere Informationen zur Zertifizierung sowie eine Liste der zertifizierten Lösungen finden Sie hier: