Dieser Artikel beschreibt die Schritte zum Hoch- und Herunterladen von Produkten mit der Scantrust-API. Zunächst benötigen Sie ein UAT-Token mit den folgenden Berechtigungen:
- Produkt erstellen
- Produkt löschen
- Produktbearbeitung
- Produktansicht
Sie müssen außerdem mindestens eine Marke im Portal einrichten: Jedes von Ihnen erstellte Produkt muss einer Marke zugewiesen werden.
Wichtig:
Um Zugriff auf die Scantrust REST API zu erhalten, können Sie eine API-Plattform wie Postman verwenden, die weltweit beliebteste API-Plattform mit über 17 Millionen Nutzern und 500.000 Organisationen weltweit. Das Tool bietet eine flexible und kollaborative Umgebung, mit der Sie Ihre APIs schneller entwerfen, entwickeln, dokumentieren und testen können.
Sie können die Webanwendung ausprobieren oder diese App über diesen Link herunterladen und installieren: https://www.postman.com/downloads/ In jedem Fall ist die Anmeldung mit einer gültigen E-Mail-Adresse erforderlich.
Hinweis: Im Scantrust-Kontext sollte Postman nur zu Testzwecken verwendet werden. Es ist nicht für den Einsatz in realen Szenarien oder Projektimplementierungen vorgesehen.
Schritte zum Konfigurieren von Postman:
1. Öffnen Sie Postman. Auf der Startseite sollten Sie Folgendes sehen:
2. Klicken Sie anschließend oben links auf den Reiter „Arbeitsbereiche“:
3. Klicken Sie anschließend auf die Option „Mein Arbeitsbereich“:
4. Sobald Sie in Ihrem Arbeitsbereich sind, klicken Sie bitte wie folgt auf das „+“-Zeichen:
5. Danach erscheint eine neue Registerkarte mit einer vorkonfigurierten API-Anfrage: GET:
6. Nun ist es wichtig, die API-Autorisierung einzurichten. Klicken Sie dazu auf den Reiter „Autorisierung“:
7. Klicken Sie dann auf den Abschnitt „Typ“ und wählen Sie die Option „API-Schlüssel“ wie folgt aus:
8. Geben Sie nun das Wort „Authorization“ in das Schlüsselfeld ein, kopieren Sie dann Ihr UAT-Token aus dem ST-Portal und fügen Sie es in das Feld mit der Bezeichnung „Value“ ein, einschließlich der Zeichen UAT:UAT [Ihr Token],Lassen Sie zwischen der UAT-Zeichenfolge und dem Token eine Leertaste:
9. Gehen Sie dann zur Registerkarte „Body“, wählen Sie „raw“ und dann „JSON“ aus:
Schritte zum Hochladen von Produkten mit der Scantrust-API
1. Jetzt können Sie ein Produkt über die Scantrust API hochladen. Im ersten Schritt müssen Sie die API-Anfrage auf „POST“ ändern. Klicken Sie dazu auf die Schaltfläche „Anfrage“ und wählen Sie die Option „POST“:
2. Um diese Anfrage einzurichten, müssen Sie die URL eingeben, die in diesem Fall wie folgt lautet: https://api.scantrust.com/api/v2/products/:
3. Schreiben Sie dann auf die Registerkarte „Text“ Folgendes:
{
"sku": "PR3",
"Marke": 2841,
"Name": "Produkt drei",
"description": "Das dritte Produkt in einer Reihe von vielen anderen.",
"client_url": "http://www.examplebrand.com/productone",
"Kampagne": 575
}
Dabei bezieht sich die SKU auf die eindeutige Produkt-SKU im Unternehmen, die Marke auf die ID (Ganzzahl) oder Referenz (Zeichenfolge) der Marke und der Name auf den Namen des Produkts. Alle diese sindPflichtfelderum die Anfrage zu stellen.
Das Beschreibungsfeld hingegen enthält eine kurze Beschreibung des Produkts, die Client-URL eine Produkt-URL, die zur Weiterleitung von Codes verwendet werden kann, wenn für das Produkt keine Kampagne aktiv ist, und das Bild ermöglicht die Einbindung eines Produktbilds, das typischerweise auf STC-Landingpages verwendet wird. Falls nicht angegeben, wird das Markenbild und die Kampagne verwendet, die die ID einer bestehenden Kampagne im Unternehmen darstellt, zu der dieses Produkt hinzugefügt werden soll.Dies sind alles optionale Felder.
4. Sobald Sie Ihr Codeskript fertiggestellt haben, können wir auf die Schaltfläche SENDEN klicken:
5. Wenn ein Produkt erfolgreich gepostet wurde, sieht die Antwort wie folgt aus:
Wenn der Upload erfolgreich war, sollte die Statusantwort 200 oder 201 lauten. Anschließend können Sie auf dem Scantrust-Portal die Erstellung dieses neuen Produkts überprüfen.
Schritte zum Herunterladen von Produkten mit der Scantrust-API
Sie benötigen ein UAT-Token mit den folgenden Berechtigungen:
- product_view
In diesem Fall rufen wir die Produktinformationen eines gesamten Unternehmens oder eines bestimmten Produkts nur anhand der Produkt-SKU ab.
1. Gehen Sie bitte zu Ihrem Arbeitsbereich in Postman und öffnen Sie eine neue Registerkarte mit dem „+“-Zeichen:
2. Gehen Sie dann zur Registerkarte „Text“ und wählen Sie „Keine“ aus:
3. Um Produktinformationen herunterzuladen, müssen Sie eine GET-Anfrage einrichten, indem Sie die URL eingeben, die in diesem Fall wie folgt lautet: https://api.scantrust.com/api/v2/products/:
4. Klicken Sie dann auf die Schaltfläche SENDEN:
5. Wenn die API-Anforderung erfolgreich war, sollte die Statusantwort 200 sein und die Antwort wird gegeben:
Diese Antwort umfasst alle Produkte, die in Ihrem Unternehmen enthalten sind, mit spezifischen Attributen wie SKU, Name, Beschreibung, Marke und anderen.
6. Wenn Sie bestimmte Produktinformationen erfahren möchten, müssen wir die GET-Anfrage durch Eingabe der URL einrichten, die in diesem Fall wie folgt lautet: https://api.scantrust.com/api/v2/products/?sku_exact=[Artikelnummer]:
In diesem Fall enthält die Antwort nur die Produktinformationen der ID, die Sie in der URL angegeben haben.
Kommentare