SELLSATION API

1. Allgemeines

2. Authentifizierung

3. Lokalisierung

4. URLs

5. Testen der API Methoden mit Swagger

1. Allgemeines

In diesem Artikel finden Sie die voraussetzenden Informationen (zB Authentifizierung) für das Arbeiten mit der SELLSATION API. Die Dokumentation selbst ist in SWAGGER (siehe Link unten im Artikel) zu sehen.

Die API ist nur per HTTPS erreichbar.

2. Authentifizierung

Die Authentifizierung erfolgt per API-Key über den SELLSATION OAuth2.0 Identity-Server.
Dieser ist über die Url https://identity.sellsation-crm.com erreichbar.

Zum Zugriff auf die API ist ein Bearer Token erfolderlich. Dieser wird im JWT-Format ausgeliefert.

Endpunkt zum Erhalt des Tokens:

• Uri: https://identity.sellsation-crm.com/connect/token
• Method: POST
• Headers
  • Accept : application/json
  • Content-Type : application/x-www-form-urlencoded
• Body
  • grant_type : client_credentials
  • client_id : sellsation.public
  • client_secret : [API-Key des Mandanten] - ist über die Web-Anwendung in der Administration abrufbar
  • scope : Scopes die angefordert werden können
    • sellsation.api.public : Lese-Zugriff
    • sellsation.api.public.write : Schreib-Zugriff
    • sellsation.api.public.admin.write: Schreib-Zugriff auf Admin Bereiche (Customfields, Produktkategorien)

Wichtig in Bezug auf den Scope ist, dass je nach benötigtem Zugriff die Scopes kombiniert, durch Leerzeichen getrennt eingetragen werden müssen, z.B.:

sellsation.api.public sellsation.api.public.write sellsation.api.public.admin.write

Aktuell gibt es keine Differenzierung des API-Keys zwischen den beiden Scopes. Dies kann sich zukünftig noch ändern (zB pro Scope ein eigener API-Key).

Der dann erhaltene Token ist eine Stunde gültig und kann zum Zugriff auf die API verw endet werden.

3. Lokalisierung

Sämtliche in SELLSATION implementierten Lokalsierungen werden auch in der API angewendet. In welcher Sprache die Lokalisierung erfolgt wird per Accept-Language-Header definiert. Aktuell werden folgende Sprachen unterstützt:

• Deutsch - de (Standardsprache)
• Englisch - en
• Italienisch - it

Sofern keine Übersetzung vorhanden ist, wird immer die Standardsprache zur Anzeige verwendet.

4. URLs

Identity Server: https://identity.sellsation.com/

Identity Server - Token Endpunkt: https://identity.sellsation.com/connect/token

5. Testen der API Methoden mit Swagger

Im folgenden Link finden Sie unsere Swagger Dokumentation:

Dokumentation der API (Swagger)

Hier können Sie Ihre Aufrufe gegen Ihren SELLSATION Mandant testen. Bitte beachten Sie dabei, dass unser Sicherheitskonzept verlangt, dass Sie, wie oben beschrieben, einen Bearer Token beziehen müssen. Kopieren Sie diesen Bearer Token in das Feld (Beschrieben als API Key) in folgender Form ein:

"Bearer <Token>"

Ersetzen Sie bitte <Token> mit dem String den Sie vom Authentifizierungsservice zurück bekommen: