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 könnenmüssen im Self-Service-Bereich von  Startseite - QSEH angelegt und verwaltet werden. Voraussetzung dafür ist, dass das verwendete Konto über die entsprechendenentsprechende BerechtigungenBerechtigung verfügt.

 

---

WasBerechtigung müssenfür SieAPI-Zugänge tun?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

1. Melden Sie sich in Startseite - QSEHmeineQSEH an.
2. LegenÖffnen Sie:
   Berechtigungen verwalten → API-Zugänge
3. Klicken Sie dortauf einen neuen API-Zugang an.„Anlegen“.
4. NotierenVergeben bzw.Sie speicherneine Sie: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:

• Tragen Sie diese Daten in die Vereinsdaten ein

Wichtig

Die Zugangsdaten sollten sicher gespeichert und

• in der Schnittstellenkonfiguration hinterlegt werden.
Insbesondere

---

Wichtige Hinweise

• Das Secret wird nur einmal angezeigt.
• Das Secret ist 2 Jahre gültig.
• Nachträglich kann das Secret kann später möglicherweise 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.

Quelle: VBG

(Hrsg.):

 Schnittstelle

für

 ermächtigte Stellen – Dokumentation, Version 3.1.