Dimona per Webservice

Sie können dem LSS Ihre Erklärungen über einen REST-Webservice senden. Ihr Softwarelieferant integriert ihn in Ihr bestehendes IT-System.

Die technischen Informationen auf dieser Seite richten sich an IT-Services und Software-Entwickler.

Benutzen Sie den REST-Webservice der sozialen Sicherheit noch nicht?

Bevor Sie den REST-Webservice der sozialen Sicherheit nutzen können, müssen Sie ein Benutzerkonto für sich oder Ihren Kunden erstellen und sich um dessen Sicherheit kümmern.

Eine Person zum technischen Verwalter ernennen

Sie können die Verwaltung Ihrer Kanäle über Chaman an Ihre IT-Abteilung delegieren. Dazu müssen Sie in den Onlinedienst Zugangsverwaltung gehen und den betreffenden Personen die Zugriffsberechtigung für den Onlinedienst Chaman erteilen.

Aktivierung und Konfiguration des REST-Kanals in Chaman

Der Onlinedienst Chaman (Channel Management) ermöglicht es Ihnen, die verschiedenen Kommunikationskanäle, die mit den Diensten der Sozialen Sicherheit verbunden sind, zu konfigurieren. Die Aktivierung des REST-Kanals für Ihr Unternehmen erfordert das Hochladen eines X.509-Zertifikats zur Identifikation Ihres Unternehmens oder Ihrer Client-Anwendung. Vor der Konfiguration von Chaman benötigen Sie dieses Zertifikat.

Ein Zertifikat zur Authentifizierung für Ihr Unternehmen erhalten

Um die Aufrufe durch Ihre Anwendung über REST APIs zu sichern, benötigen Sie ein Authentifizierungszertifikat auf den Namen Ihres Unternehmens. Sie haben mehrere Möglichkeiten:

Sie können das Zertifikat bei einer anerkannten Zertifizierungsstelle bestellen. Hier ist eine Liste der derzeit unterstützten Zertifizierungsstellen:

Zertifizierungs-stelle	Zertifikatstyp	Link
GlobalSign	PersonalSign 3 Pro	https://shop.globalsign.com/en/belgian-government-services

Sie können ein selbstsigniertes Zertifikat auf den Namen Ihres Unternehmens verwenden.
Das Verfahren zur Erstellung eines solchen Zertifikats wird hier derzeit nicht beschrieben. Normalerweise wird die Erstellung eines solchen Zertifikats von der IT-Abteilung Ihres Unternehmens durch die Verwendung eines Tools wie OpenSSL unterstützt. Bitte beachten Sie die folgenden Einschränkungen bei der Erstellung Ihres selbstsignierten Zertifikats:

Zu respektierende Kriterien	Zulässige Werte
Algorithmus zur Erzeugung des Schlüsselpaares	RSA oder EC
Schlüsselgröße (Bits)	Für RSA : 2048, 3072 oder 4096 Für EC : P-384 oder P-521
Digest-Algorithmus, der mit der Signatur des Zertifikats verbunden ist	SHA-256, SHA-384 oder SHA-512
Key Usage des Zertifikats	Digital Signature

Konfiguration des REST-Kanals in Chaman

Um den REST-Kanal zu aktivieren und Ihr Authentifizierungszertifikat zu konfigurieren, loggen Sie sich in den Onlinedienst von Chaman ein.

Wenn beim Zugriff auf Chaman die Kontaktdaten des technischen Zugangsverwalters Ihres Unternehmens nicht verfügbar sind, müssen Sie diese ergänzen (und registrieren), bevor Sie die folgenden Aktionen durchführen können.

Klicken Sie in Chaman in dem Abschnitt, der mit den Webservicekanälen verbunden ist, auf „Webservicekonto hinzufügen“. Füllen Sie dann das unten sichtbare Formular wie folgt aus:

Wählen Sie den Typ REST. Nach der Auswahl wird die Liste der zugehörigen Felder angezeigt.
Geben Sie den Namen ein, den Sie Ihrem REST-Konto geben möchten.
Wählen Sie die Berechtigung(en), die Sie diesem Konto zuweisen möchten.
Laden Sie das Authentifizierungszertifikat, das von Ihrem REST-Client verwendet wird. Sie müssen einen Namen für das Zertifikat angeben.
Klicken Sie auf die Schaltfläche „Bestätigen“, um die Erstellung des REST-Kontos zu bestätigen.

Am Ende dieses Schrittes wird die OAuth Client ID angezeigt, die mit diesem Konto verbunden ist. Diese Client ID hat die Form "self_service_expeditor_X" (wobei X die Ihnen zugewiesene Absendernummer ist).

Bitte bewahren Sie diese Client ID auf, da sie bei der Beantragung Ihres OAuth Access-Token verwendet wird.

Einrichten der OAuth-Sicherheit

Der REST-Webservice der sozialen Sicherheit ist gesichert. Bevor Sie ihn verwenden können, müssen Sie das OAuth-Sicherheitsprotokoll implementieren. Hilfe finden Sie in der folgenden Dokumentation:

OAuth2 Integration Client Credential .pdf - Neues Fenster
Java Code zur Implementierung von OAuth: ClientCredentialTokenGenerator.java Neues Fenster

DerREST-Webservice für Dimona

EineBesonderheit des REST-Webservices für Dimona ist, dass das LSS keine synchrone Bearbeitung der Erklärungen garantieren kann. Aus diesem Grund ist die Funktionsweise des Webservices in zwei separate Transaktionen unterteilt:

POST:eine Erklärung einreichen, und
GET:das Ergebnis der Verarbeitung der Deklaration anzeigen.

DieBearbeitungszeit einer Dimona variiert. Dies bedeutet, dass Sie möglicherweise mehrere „GET“-Aufrufe durchführen müssen, um das Ergebnis der Verarbeitung Ihrer Erklärung zu sehen. Sie müssen daher einen „Retry“-Mechanismus implementieren, wie in unserer Dokumentation beschrieben. Wir erklären Ihnen auch, welche Häufigkeit Ihr „Retry“ haben sollte, um das Dimona-System nicht mit Aufrufen zu überfluten.
Sofunktioniert es: Funktionsdokumentation REST-Webservice für Dimona (auf Französisch) .pdf - Neues Fenster