OAuth2 / API Dokumentation
URL: https://www.psponline.de
Für die Autorisierung unserer OAuth2-Schnittstelle verwenden wir den Grant Type "Client credentials". Diese bekommst du von uns mitgeteilt und sehen beispielhaft wie folgt aus:
Client ID: 30000#m.mustermann (Lizenznummer#Benutzername)
Client Secret: Eine zufällige, von uns vergebene Zeichenkette
Die Angabe eines Scopes ist nicht erforderlich.
Wichtiger Hinweis:
Die Endpunkte mit dem v1 Präfix in der URI sind inhaltlich bzgl. der Rückgabewerte zu 100% kompatibel mit der vorhergehenden Schnittstelle.
Endpoints
-
POST - /api/token
Liefert unter Angabe der client credentials einen Access-Token zurück. -
POST - /api/v1/frontend-session[/{offerId}]
302 (Found): Erzeugt Weiterleitung inkl. einer Session in der Oberfläche von psponline. Wenn optional eine Angebot ID (offerId) mit angegeben wird, startet man in der Oberfläche direkt mit dem Angebot. Ebenso können optional per POST beliebige Erfassungsfelder mit übergeben werden.
401 (Unauthorized): Kein gültiger Nutzer
-
GET - /api/v1/quotes/latest
200 (OK): Gibt immer das zuletzt erstellte Angebot zurück (JSON+PDF's).
404 (Not Found): Es wurde bis jetzt kein Angebot erstellt
-
GET - /api/v1/quotes/{id}
200 (OK): Gibt ein spezifisches Angebot unter Angabe der Angebot ID (offerId) zurück (JSON+PDF's). Die Angebot-ID muss zuvor über den Endpunkt /api/v1/offer/latest geholt worden sein.
404 (Not Found): Das angeforderte Angebot wurde nicht gefunden
-
GET - /api/v1/plans
200 (OK): Gibt eine Liste der Tarife zurück (JSON).
404 (Not Found): Zugriff nicht erlaubt
-
GET - /api/v1/premiums
200 (OK): Gibt eine Liste der Beiträge zurück (JSON).
404 (Not Found): Zugriff nicht erlaubt
-
GET - /api/v1/companies
200 (OK): Gibt eine Liste der Gesellschaften zurück (JSON).
404 (Not Found): Zugriff nicht erlaubt
-
GET - /api/v1/types
200 (OK): Gibt eine Liste der Tarifarten zurück (JSON).
404 (Not Found): Zugriff nicht erlaubt
-
GET - /api/v1/occupational-groups
200 (OK): Gibt eine Liste der Berufsgruppen zurück (JSON).
404 (Not Found): Zugriff nicht erlaubt
-
GET - /api/v1/granting-authorities
200 (OK): Gibt eine Liste der Beihilfeträger zurück (JSON).
404 (Not Found): Zugriff nicht erlaubt