Die Authentifizierung bei jedem Zugriff auf die API ist unerlässlich, um die Sicherheit des Dienstes und der Daten, auf das zugegriffen werden soll, zu gewährleisten.

Inhaltsverzeichnis

1 API-Authentifizierung
- 1.1 Authorization-Token anfragen
  - 1.1.1 Request
  - 1.1.2 Content-Type
  - 1.1.3 Request-Body
  - 1.1.4 Response
  - 1.1.5 Fehlerbehandlung
  - 1.1.6 Anwendungsbeispiel Token anfragen mit Curl
- 1.2 Authorization-Token verwenden

API-Authentifizierung

Um auf die API zugreifen zu können, benötigen Sie ein Benutzerkonto im WEBSALE Online Servicebereich. Dieses Benutzerkonto muss Zugriff auf den Dienst haben, auf den Sie über die REST API zugreifen möchten.

Die Zugangsdaten dieses Benutzerkontos können für die API-Authentifizierung verwendet werden. Wenn Sie separate Zugangsdaten für die WEBSALE API verwenden möchten oder Probleme mit der Authentifizierung haben, wenden Sie sich bitte an unser Backoffice.

Authorization-Token anfragen

Für die Authentifizierung müssen die OSB-Login-Daten und die ShopID übergeben werden.

Request

POST https://www.websale.de/api/authent/login/SHOPID

Content-Type

application/json

Request-Body

Eigenschaft	Typ	Beschreibung

Eigenschaft	Typ	Beschreibung
username	string	Benutzerkennung, die auch für die Authentifizierung im OSB verwendet wird
password	string	Passwort, das auch für die Authentifizierung im OSB verwendet wird

Beispiel
In diesem Beispiel wird der User "websaleuser" mit dem Passwort "meinpasswort" authentifiziert.

{
    "username": "websaleuser",
    "password": "meinpasswort"
}

Response

Bei Erfolg wird ein TOKEN zurückgegeben.

{
    "token": "TOKEN"
}

Fehlerbehandlung

Status-Code	Bedeutung	Beschreibung

Status-Code	Bedeutung	Beschreibung
400	Bad Request	Übergabe ist nicht korrekt (Formatierungsfehler/fehlende Felder) oder unbekannte Aktion
401	Unauthorized	User hat keine Berechtigungen für die angegebene ShopID
403	Forbidden	Unbekannte bzw. falsche Login-Daten
423	Locked	User wurde wegen mehrfach fehlerhaften Logins zeitweise auf die Sperrliste gesetzt

Anwendungsbeispiel Token anfragen mit Curl

Der User "websaleuser" soll für die ShopID "meinshop" authentifiziert werden.

Authorization-Token verwenden

Der TOKEN wird im Header bei jedem Folgeaufruf übergeben.

Der generierte Token ist nur für einen Zeitraum von 30 Minuten gültig. Sobald dieser nicht mehr gültig ist, geben alle Anfragen den Statuscode 401 zurück. Ist dies der Fall muss ein neuer Token generiert werden.

Dokumentation

REST-Authentifizierung