REST-Schnittstelle

Vollständige API-Dokumentation für die Integration mit Shoporama

Bitte beachten Sie

Die Dokumentation wurde in die neue Swagger-Benutzeroberfläche verschoben. Diese Seite wird nicht mehr gepflegt und kann veraltete Informationen enthalten.

Endpunkte

Über die REST-Schnittstelle

Unsere REST-Schnittstelle ist so konzipiert, dass unsere Kunden selbst Integrationen mit Lager- und Buchhaltungssystemen entwickeln können. Es sind daher nur Methoden, die das unterstützen, was wir unterstützen.

Wir verwenden das HTTP-Protokoll über SSL/TLS und alle Daten werden im JSON-Format gesendet und empfangen.

Die Autorisierung erfolgt auf Shop-Ebene, und jeder Shop hat die Möglichkeit, dievon ihm gewünschten Token zu erstellen. Standardmäßig erlaubt jedes Token 1.000 Anrufe pro Tag. Dieses Limit kann erhöht werden, wenn Sie sich mit uns in Verbindung setzen und den Grund dafür angeben. Um das Token festzulegen, muss eine Autorisierungskopfzeile wie die unten stehende angegeben werden:

Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb

Beachten Sie, dass die oben genannte Methode Shoporama sein muss.

Paginierung

Bei Aufrufen, die Listen enthalten - z. B. Produkte oder Bestellungen - gibt es eine maximale Anzahl von Ergebnissen, die wir zurückgeben. Daher enthält das Ergebnis ein Paging-Element, das anzeigt, welchen Teil des Datensatzes Sie gerade betrachten:

{
  "paging": {
    "offset": 30,
    "limit": 10,
    "count": 10,
    "total": 1000
  },
  "products": [
    [...]
  ]
}

Um auszuwählen, welcher Teil des Datensatzes betrachtet werden soll, können Sie die Argumente limit=100 und offset=30 in der URL angeben, die Sie aufrufen.

Beispiel für einen API-Aufruf

Ein vollständiges Beispiel dafür, wie Produkte, die sich seit dem 1. Januar 2020 geändert haben, gezogen werden können:

Anfrage:

GET /REST/product?last_modified=2020-01-01T00:00:00&limit=100 HTTP/1.1
Host: www.shoporama.dk
Accept: */*
Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb
User-Agent: Min Shoporama integration

Antwort:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "paging": {
    "offset": 30,
    "limit": 10,
    "count": 10,
    "total": 1000
  },
  "products": [
    [...]
  ]
}

Notsituation