Schnittstelle einrichten (Neu Juni)

Quelle: VBG (Hrsg.): Schnittstelle für ermächtigte Stellen – Dokumentation, Version 3.1.

Mit der neuen VBG-Schnittstelle werden automatische Datenübertragungen künftig über sogenannte API-Zugänge durchgeführt. Die API-Zugänge müssen im Self-Service-Bereich von Startseite - QSEH angelegt und verwaltet werden. Voraussetzung dafür ist, dass das verwendete Konto über die entsprechende Berechtigung verfügt.

Berechtigung für API-Zugänge vergeben

Damit ein Nutzer API-Zugänge verwalten kann, muss ihm im Portal die Berechtigung
„API-Zugänge verwalten“ zugewiesen werden.

Die Vergabe erfolgt über:
Berechtigungen verwalten

Mit dieser Berechtigung können API-Zugänge:

angezeigt
angelegt
gelöscht

werden.

API-Zugang anlegen

Melden Sie sich in meineQSEH an.
Öffnen Sie:
Berechtigungen verwalten → API-Zugänge
Klicken Sie auf „Anlegen“.
Vergeben Sie eine Bezeichnung für den API-Zugang.
- maximal 20 Zeichen
- möglichst eindeutig und nachvollziehbar

Nach dem Anlegen werden automatisch folgende Daten erzeugt:

Client-ID
Secret
Kontext-ID

Diese Informationen müssen anschließend:

sicher gespeichert und
in der Schnittstellenkonfiguration hinterlegt werden.

Wichtige Hinweise

Das Secret wird nur einmal angezeigt.
Das Secret ist 2 Jahre gültig.
Nachträglich kann das Secret nicht erneut angezeigt werden.
Geht das Secret verloren, muss ein neuer API-Zugang angelegt werden.

Ohne gültiges Secret ist keine Anmeldung an der Schnittstelle möglich.