...
Die REST-Schnittstelle dient dazu, einen beliebigen OSB-Dienst automatisiert aufzurufen.
Beispiel:
Ein ERP-System überträgt per SFTP Produktbilder auf den Shopserver. Nach der Bild-Übertragung wird der Bildkonverter per REST-Aufruf gestartet, um die Produktbilder zu konvertieren und zu optimieren.
Aufruf
Der Aufruf der REST-Schnittstelle ähnelt bei jedem OSB-Dienst und hat folgenden Aufbau der URL:
https://www.websale.de/api/SERVICEID/ACTION
SERVICEID repräsentiert einen OSB-Dienst, wobei dies nicht unbedingt gleichgestellt ist mit der AppID des Dienstes.
ACTION bekommt der Dienst als Parameter übergeben und der Dienst kann dann darauf reagieren.
Wenn ein Dienst eine Aktion nicht kennt, sollte immer ein HTTP-Fehlercode 400 (Bad Request) zurückgegeben werden.
Beim Aufruf der URL wird der entsprechende Dienst mit folgenden Parametern aufgerufen:
"isrest=yes&action=ACTION"
...
| Code Block |
|---|
<IfModule mod_rewrite.c>
RewriteEngine on
...
RewriteCond %{QUERY_STRING} ^(.*)$
RewriteRule ^/api/ID/(.*) /cgi/APP/APP.cgi?isrest=yes&action=$1&%1 [PT]
...
</IfModule> |
Authentifizierung
Es ist bei jedem OSB-Dienst wichtig, dass der User sich zuerst authentifiziert und dem Aufruf einen Token mitgibt. Wie ein Token beim Authentserver erzeugt wird, ist in der Dokumentation "REST Authentifizierung" beschrieben:
Token
Der Token ist ein “JSON Web Token” (JWT) und besteht aus 3 Teilen:
...