Bitte warten Sie...

OAuth2 / API Dokumentation

URL: https://testen.psponline.de

Für die Authorisierung unserer OAuth2-Schnittstelle verwenden wir den Grant Type "Client credentials". Diese bekommen Sie 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 inhaltich bzgl. der Rückgabewerte zu 100% kompatibel mit unserer bestehenden Schnittstelle. Daher können Sie sich bzgl. der genauen Details zu den Feldbezeichnungen unsere bestehende Dokumentation analog anschauen. Diese finden sie unter: Beispiel (PHP) bzw. Erfassungsfelder

Endpoints

  • POST - /api/token

    Liefert unter Angabe der client credentials einen Access-Token zurück
  • GET - /api/frontend-session[/{offerId}]

    Erfolg (302): 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 GET beliebige Erfassungsfelder mit übergeben werden.

  • GET - /api/v1/offer/latest

    Erfolg (200): Gibt immer das zuletzt erstellte Angebot (json+pdf's) zurück

    Fehler (404): Es wurde bis jetzt kein Angebot erstellt

  • GET - /api/v1/offer/{offerId}

    Erfolg (200): Gibt ein spezifisches Angebot (json+pdf's) unter Angabe der Angebot ID (offerId) zurück. Die Angebot ID muss zuvor über den Endpunkt /api/v1/offer/latest geholt werden

    Fehler (404): Das angeforderte Angebot wurde nicht gefunden