API-Dokumentation Produktbewertungen
- Suzana Fodermeyer
- Dirk Stuwe
Abrufen von Produktbewertungen
Die API erlaubt den Abruf von Produktbewertungen eines durch die SKU, GTIN oder Produkt-URL identifizierten Produktes. Die Rückgabe umfasst den Text der Bewertungen, das Erstellungsdatum, die Anzahl der Sterne, die ID der Bewertung und den Anzeigenamen des Autors, der die Bewertung verfasst hat. Am Ende des Dokumentes finden Sie Response-Beispiele.
Schritt 1 - Autorisierung
Authorization HTTP-Request: | ||
Methode | GET | |
URL |
| |
Request Header |
Apikey, Apisecret erhält der Händler aus dem Händlerbereich unter dem Punkt “VotesAPI”. Der Identifier entspricht dem 3-stelligen Code für das jeweils verwendete Shopsystem (siehe unten; Tabelle “Identifier für Shopsysteme”) |
|
Response(Token-Lifetime= 1 Std.) Info: Der Token enthält die ShopID. | JSON-Objekt: {"Code": <ReturnCode>, "Token": "<JSON-Web-Token String>"} Beispiel: *Informationen zum JSON-Web-Token (JWT): https://jwt.io | |
Hinweis: Es sind ausschließlich HTTP 1.1 Requests erlaubt.
Schritt 2 - Abruf von Produktbewertungen
Review HTTP-Request | |
Methode | GET |
URL |
|
Request Header | User-Agent: App.<Identifier>.<ShopID> Token: Bearer <JSON-Web-Token> |
Response | (siehe Listing unten) |
Zusätzliche Request-Parameter | |
gtin (empfohlen) | Die GTIN des Produktes. Beispiel: |
productUrl | Die URL-kodierte Produkt-URL des Produktes. Beispiel: |
sku | Die SKU des Produktes. |
sd (true | false) | Gibt an, ob strukturierte Daten zurückgegeben werden sollen. Wird der Parameter nicht angegeben, werden standardmäßig strukturierte Daten ausgegeben. Mit dem Wert “false” kann die Rückgabe strukturierter Daten unterdrückt werden. |
lang | Filtert die Bewertungen nach Sprache. Wird der Parameter nicht angegeben, werden alle Bewertungen in allen Sprachen ausgegeben. |
days (max. 365) | Gibt alle Produktbewertungen (unabhängig vom Produkt) des Händlers innerhalb der angegebenen Anzahl von Tagen zurück. Die Response enthält zusätzlich die Felder gtin und sku zur Identifikation des Produktes im Shop |
Tabelle - Identifier für Shopsysteme
Shopsystem | <Identifier> | Shopsystem | <Identifier> |
Shopware | GDX | Modified | RF5 |
JTL-Shop | T6Z | Prestashop | KR2 |
Shopify | GF3 | VersaCommerce | Q6T |
WooCommerce | SB3 | xt:Commerce | 5ZK |
Magento | AE2 | Self-programmed | HL3 |
Gambio | W8F | 3rd-Party / Integration über Drittanbieter | E5G |
PlentyMarkets | K4V | Azoo | AJ4 |
SmartStore | TV1 | ePages | FB6 |
OpenCart | N7P | Strato | M3F |
HostEurope | D8N | IONOS | PL7 |
DomainFactory | X6G | Telekom | B5Z |
Serverspot | S3T |
|
|
Response Error-Codes:
400 = {"Code":400,"Message":"Error: Bad API-Call"}
401 = {"Code":401,"Message":"Error: No parameters given"}
402 = {"Code":402,"Message":"Error: Payment Required - API-Zugriff nicht erlaubt"}
405 = {"Code":405,"Message":"Error: Bad JSON Web Token or Token expired"}
406 = {"Code":406,"Message":"Error: AUTHORIZATION-Header not set"}
407 = {"Code":407,"Message":"Error: Invalid data send"}Response: JSON ohne strukturierende Daten für Produktbewertungen:
Response: JSON mit strukturierten Daten als JSON+LD Code Snippet:
