Schnittstelle einrichten (Neu ab Juni, in Arbeit)

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 der angemeldeter Nutzer der ermächtigten Stelle über die Berechtigung „API-Zugänge verwalten“ verfügt. Diese kann dem Nutzer im Self-Service-Bereich unter der Schaltfläche „Berechtigungen verwalten“ zugewiesen werden. 

Was müssen Sie tun?

1. Melden Sie sich in Startseite - QSEH an.
2. Öffnen Sie:
   Berechtigungen verwalten → API-Zugänge
3. Klicken Sie auf „Anlegen“.
4. 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
• unter Vereinsdaten im Kursmodul von Ihnen hinterlegt werden.

Hinweise

• Dieser Vorgang ist von einem Nutzer der ermächtigten Stelle durchzuführen
• 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.