Abfrage von Bürgerdaten über Webservice
Um Bürgerdaten aus Ihrer eigenen Softwareumgebung abfragen zu können, aktivieren Sie zwei Webservice-Kanäle. Die Kommunikation erfolgt über den gesicherten API-Gateway der Sozialen Sicherheit.
Mit der REST-API GrantCitizen beantragen Sie den Zugang zu Bürgerdaten. Dieser Webservice kommuniziert mit der Zentralen Datenbank der sozialen Sicherheit und ist die Basis für die Abfrage von Bürgerdaten.
Mit der REST-API PrecontractualInformation kommunizieren Sie mit Sigedis. Mit diesem Webservice beantragen Sie Bürgerdaten , wenn Sie zuvor die Zustimmung über GrantCitizen erhalten haben.
Die technischen Informationen auf dieser Seite richten sich an IT-Dienste und Softwareentwickler.
Schritte vor der Integration der REST-Webservices
Wie bei jeder REST-API (Representational State Transfer API) müssen Sie vor der Integration des REST-Webservices in Ihr IT-System einige Schritte durchführen:
- Identifizieren Sie Ihr Unternehmen als Arbeitgeber und ernennen Sie einen Hauptzugangsverwalter.
- Konfigurieren Sie den REST-Kanal in Chaman.
- Beantragen Sie einen Zugangstoken.
- Verwenden Sie den Zugangstoken für die Aufrufe.
Technische Informationen zu diesen Schritten finden Sie auf der REST-Dokumentationswebsite (auf Englisch) Nieuw venster.
Funktionen der REST-Webservices
Um die Bürgerdaten abfragen zu können, müssen Sie zwei Kanäle im Onlinedienst Chaman (Channel Management) öffnen:
- GrantCitizen: „Bürgervollmachten verwalten“, mit dem Ihr Unternehmen Bürger um eine Vollmacht bittet und diese Vollmachten verwaltet, und
- PrecontractualInformation: „Abfrage von Bürgerdaten“, um Bürgerdaten abzufragen, wenn ein Bürger den Zugang genehmigt hat.
Wichtig: Richten Sie einen „Circle of Trust“ ein
Die Webservices können erst dann genutzt werden, wenn Ihr Unternehmen einen „Circle of Trust“ eingerichtet hat, um die Informationssicherheit zu gewährleisten. Der Hauptzugangsverwalter Ihres Unternehmens muss die Nutzungsbedingungen für den Webservice Nieuw venster akzeptieren.
Technische Dokumentation
- eGov3.0 – Consultation des données du citoyen – session d’information V5.2 (auf Französisch) .pdf - Nieuw venster
- Anleitung GrantCitizen REST API (auf Englisch) .pdf - Nieuw venster
- GrantCitizen API Documentation Nieuw venster
- Anleitung PrecontractualInformation REST API (auf Englisch) .pdf - Nieuw venster
- PrecontractualInformation API Documentation Nieuw venster