REST-Authentifizierung

Jeder Zugriff auf eine REST-Schnittstelle eines OSB-Dienstes beginnt mit einem Token. Sie fordern es mit Ihren Zugangsdaten für den Online-Servicebereich an und schicken es bei jedem weiteren Aufruf im Header mit.

Voraussetzung

Sie brauchen ein Benutzerkonto im Online-Servicebereich, und dieses Konto muss Zugriff auf genau den Dienst haben, den Sie über die API ansprechen wollen. Die Zugangsdaten dieses Kontos verwenden Sie auch für die API. Wenn Sie für die API lieber separate Zugangsdaten hätten oder die Authentifizierung scheitert, wendet sich Ihr Ansprechpartner an das WEBSALE-Backoffice.

Token anfordern

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

Content-Type: application/json

Eigenschaft	Typ	Beschreibung
`username`	string	Benutzerkennung, dieselbe wie im Online-Servicebereich
`password`	string	Passwort, dasselbe wie im Online-Servicebereich

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

Bei Erfolg antwortet der Server mit dem Token:

{
    "token": "TOKEN"
}

Beispiel mit curl

Der Benutzer websaleuser wird für die ShopID meinshop authentifiziert:

curl \
 -X POST \
 -H "Content-Type: application/json" \
 -d '{
    "username": "websaleuser",
    "password": "meinpasswort"
}' \
"https://www.websale.de/api/authent/login/meinshop"

Token verwenden

Das Token gehört in den Header jedes Folgeaufrufs:

X-Authorization: Bearer TOKEN

Es ist 30 Minuten gültig. Danach antwortet jede Anfrage mit dem Statuscode 401 und Sie fordern ein neues Token an.

Statuscodes

Status-Code	Bedeutung	Beschreibung
400	Bad Request	Übergabe nicht korrekt, also Formatierungsfehler oder fehlende Felder, oder unbekannte Aktion
401	Unauthorized	Der Benutzer hat keine Berechtigung für die angegebene ShopID
403	Forbidden	Unbekannte oder falsche Login-Daten
423	Locked	Der Benutzer wurde wegen mehrfach fehlerhafter Logins zeitweise gesperrt

Der Unterschied zwischen 401 und 403 ist bei der Fehlersuche hilfreich: 403 heißt, die Zugangsdaten stimmen nicht, 401 heißt, sie stimmen, aber das Konto darf nicht auf diesen Shop zugreifen.

Schnittstellen

Voraussetzung

Token anfordern

Beispiel mit curl

Token verwenden

Statuscodes

Verwandte Themen

​Voraussetzung

​Token anfordern

​Beispiel mit curl

​Token verwenden

​Statuscodes

​Verwandte Themen

Voraussetzung

Token anfordern

Beispiel mit curl

Token verwenden

Statuscodes

Verwandte Themen