Zum Hauptinhalt springen

OAuth-Scopes für empfangende Systeme

Für den Zugriff auf die Submission API werden vom Autorisierungsserver Berechtigungen in Form von OAuth-Scopes vergeben. Empfangende Systeme werden damit berechtigt, Einreichungen abzuholen.

Typischerweise existiert für einen Zustellpunkt genau ein empfangsberechtigtes System (z.B. ein Verwaltungssystem oder eine virtuelle Poststelle). Berechtigungen für empfangende Systeme werden beim Anlegen eines Zustellpunktes im Self-Service-Portal vergeben.

Scopes für empfangende Systeme

Achtung

Beim Abruf von Access-Tokens ist es ist technisch möglich, die gewünschten OAuth-Scopes explizit anzugeben. Jedoch können Namen und Anzahl von OAuth-Scopes im Rahmen von API-Updates durch FIT-Connect geändert werden. Und dies auch ohne Veröffentlichung einer Major-Version und der Beachtung der zugehörigen Migrationsfrist. Die explizite Angabe von OAuth-Scopes kann beim Abholen eines Access-Tokens unter diesen Umständen zu einem Bruch der Verbindung führen. Daher raten wir ausdrücklich von der expliziten Angabe von OAuth-Scopes ab!

Für empfangende Systeme gibt es zwei verschiedene Scopes:

  • https://schema.fitko.de/fit-connect/oauth/scopes/manage-destinations zur Verwaltung von Zustellpunkten
  • https://schema.fitko.de/fit-connect/oauth/scopes/subscribe-destinations als Empfangsberechtigung für Zustellpunkte

Um beispielsweise eine Einreichung abzurufen oder den Abruf einer solchen zu Bestätigen ist der Scope https://schema.fitko.de/fit-connect/oauth/scopes/subscribe-destinations nötig. Möchte man die Stammdaten eines Zustellpunktes ändern (z.B. die angebotenen Verwaltungsleistungen), so benötigt man den Scope https://schema.fitko.de/fit-connect/oauth/scopes/manage-destinations.

Destination-Limits

Bitte beachten Sie die folgenden Destination-Limits:

  • Destinations pro Owner (User): Keine Limitierung der Destinations auf Seiten des Owners.
  • Destinations pro Client (API-Client): Maximal 5000 Destinations pro Client.