Unbenannt So laden Sie SCM-Daten über die Scantrust-API hoch – ScanTrust Help Center

Um SCM-Daten in die Scantrust-API hochzuladen, unterstützt Scantrust zwei Methoden:Synchron Und Asynchron, jede mit ihren Einschränkungen und Vorteilen. Bevor Sie sich für die für Ihren Anwendungsfall am besten geeignete Methode entscheiden, sollten Sie die Unterschiede verstehen.

Synchrone SCM-Uploads

Beim synchronen Hochladen von Daten verarbeitet und aktualisiert die API alle Ihre Daten innerhalb der Dauer des HTTP-Aufrufs. Wenn viele Daten gesendet oder viele Codes aktualisiert werden, kann es bei dieser Methode zu einem Timeout kommen, sodass die Anfrage erneut gesendet werden muss. Aus diesem Grund Die synchrone Update-Methode ist nur bei geringen Datenmengen sinnvoll

Asynchrone SCM-Uploads

Beim asynchronen Hochladen von Daten erstellt die API einen Hintergrundjob, um Ihre Daten zu aktualisieren und antwortet sofort mit einem Aufgaben-ID, Das Aufgaben-ID kann verwendet werden, um den Jobstatus zu überprüfen (ausstehend, ausgeführt, Fehler, ...)

Auswahl zwischen synchron und asynchron

Synchrone Updates sind aufgrund der sofortigen Reaktion am einfachsten einzurichten. Sie werden jedoch nur empfohlen, wenn die Anzahl der aktualisierten Codes gering ist (weniger als 1000). Wenn hingegen die asynchrone Methode für SCM-Updates erforderlich ist, muss Ihre Integration dieAufgaben-IDum das Ergebnis des SCM-Updates herauszufinden.

Wichtig

Zum Hochladen von Daten, egal ob synchron oder asynchron, benötigen Sie ein UAT-Token mit den folgenden Berechtigungen:

Codes_Ansicht
scm_bulk_edit
scm_code_edit
Produktansicht

Darüber hinaus ist es wichtig, Folgendes sicherzustellen:

Sie haben die Rolle eines Markeninhabers/SCM-Benutzers im Scantrust-Portal:
Eine Kampagne, die so eingerichtet ist, dass sie die gewünschten SCM-Felder enthält. Beispiel:
- Produktionsdatum, vorgesehener Markt, RFID, …
- Hinweis: SCM-Felder, die nicht in der Kampagne enthalten sind, werden vom System verworfen.
Ein Arbeitsauftrag für ein Produkt, das in der Kampagne enthalten ist und über gültige Codes verfügt, die aktualisiert werden müssen.

Um Zugriff auf die Scantrust REST API zu erhalten, können Sie eine API-Plattform wie Postman verwenden. Postman ist 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. Gehen Sie dann zur Registerkarte „Arbeitsbereiche“ in der oberen linken Ecke.

3. Klicken Sie 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:

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 SCM – synchron

Daten müssen im JSON-Format hochgeladen werden. Die API akzeptiert Batches von Elementen nicht größer als 100 pro Aufruf. Daher müssen die Daten in Batches von maximal 100 Elementen pro POST-Anfrage aufgeteilt werden. Es wird empfohlen, eine Protokolldatei mit den Schlüsseln/Batchnummern zuvor hochgeladener Elemente zu führen, damit diese beim Hochladen übersprungen werden können. Dies verhindert, dass Elemente doppelt hochgeladen werden, wenn die API ein fehlerhaftes Element in einem bestimmten Batch abfängt.

1. Um diese POST-Anfrage einzurichten, müssen Sie die URL eingeben, die in diesem Fall wie folgt lautet: https://api.scantrust.com/api/v2/scm/hochladen :

2. Anschließend müssen Sie auf der Registerkarte „Body“ das JSON gemäß folgendem Beispiel festlegen:

{
"data_key": "erweiterte ID",
"Artikel": 
[
{"extended_id": "HGDTQD54D5SD86EEDFS", "intended_market": "cn"},
{ "extended_id": "JF5FPO58DFITE4EDXD2", "intended_market": "de"}
]
}

Dabei muss der „data_key“ ausgewählt werden, um die gewünschten Codes zum Hochladen von Daten auszuwählen. Es gibt zwei Möglichkeiten, einen Schlüssel zu bestimmen:

Standardmäßig ist dieser Schlüssel erweiterte_ID (die einzigartige Nachricht, die jeder Code enthält).
Der Schlüssel kann auch eingestellt werden auf Seriennummer wenn diese auf die Codes eingestellt sind.

Darüber hinaus beziehen sich die „Elemente“ auf die Liste der SCM-Daten in Schlüssel-Wert-Paaren, die in einzelne Codes hochgeladen werden sollen. Jeder Datenschlüssel muss auf den Schlüssel des in der Kampagne definierten SCM-Felds verweisen. Die Namen der Schlüssel können durch Herunterladen der Datei template.csv von der Registerkarte „SCM T&T“ für die Kampagne bestätigt werden.

3. Sobald Sie Ihr Codeskript fertiggestellt haben, können wir auf die Schaltfläche SENDEN klicken.

4. Sobald ein Stapel von maximal 100 Codes erfolgreich veröffentlicht wurde, erhalten Sie eine Antwort mit den betroffenen und veröffentlichten Codes. Im Anschluss an die Antwort sollten Sie Folgendes erhalten:

5. Zu guter Letzt können Sie im Abschnitt „Code-Transaktionen“ im Scantrust-Portal überprüfen, ob diese Codes von diesem Update betroffen sind:

In diesem Fall haben wir für einen bestimmten Code das Feld „intentioned_market“ auf China aktualisiert.

Schritte zum Hochladen von SCM – Asynchron

Ähnlich wie beim synchronen Prozess ist es wichtig, Folgendes sicherzustellen:

Markeninhaber/SCM-Benutzerkonto im Scantrust-Portal:
Eine Kampagne, die so eingerichtet ist, dass sie die gewünschten SCM-Felder enthält:
- Beispiel: Produktionsdatum, beabsichtigter Markt, RFID, ...
- Hinweis: SCM-Felder, die nicht in der Kampagne enthalten sind, werden vom System verworfen.
Ein Arbeitsauftrag für ein Produkt, das in der Kampagne enthalten ist und über gültige Codes verfügt, die aktualisiert werden müssen.

Daten müssen im JSON-Format hochgeladen werden. Die API akzeptiert maximal fünf Constraints mit maximal 1.000 Werten. Die Daten müssen in Batches aufgeteilt werden, die dieselben SCM-Daten enthalten. Es wird empfohlen, eine Protokolldatei mit den Schlüsseln/Batchnummern zuvor hochgeladener Elemente zu führen, damit diese beim Hochladen übersprungen werden können. Dadurch wird verhindert, dass Elemente doppelt hochgeladen werden, wenn die API ein fehlerhaftes Element in einem bestimmten Batch abfängt.

1. Um diese POST-Anfrage einzurichten, müssen Sie die URL eingeben, die in diesem Fall wie folgt lautet: https://api.scantrust.com/api/v2/scm/hochladen/asynchron/:

Durch das Senden von Daten an diesen Endpunkt wird ein ASYNC-Serverjob erstellt, der jeden Code in Ihrem Unternehmen bearbeiten kann, um die gewünschten SCM-Daten zu erhalten. Der Endpunkt gibt einen Aufgaben-ID Hiermit kann der Status des Auftrags überprüft werden.

2. Anschließend müssen Sie auf der Registerkarte „Body“ das JSON wie folgt festlegen:

{
"Einschränkungen":{
"extended_id": ["ACsofByKKTvj", "Bjr1U5dt3M8X", "JKZlcPU6Za4q"]
},
"scm_data": {
"Kaufnummer": "test19102022"
},
"Referenz": "SCM-Upload"
}

Die „Einschränkung“ muss die gewünschten Codes enthalten, für die Daten hochgeladen werden sollen, und die „scm_data“ sollten das zu aktualisierende Feld und den darin enthaltenen Wert enthalten.

3. Sobald Sie Ihr Codeskript fertiggestellt haben, können wir auf die Schaltfläche SENDEN klicken.

4. Wenn die Anfrage erfolgreich ist, wird die Antwort 200 OK im Ergebnis angezeigt. Zusätzlich gibt die API eineAufgaben-IDmit dem der Auftragsstatus abgefragt werden kann:

5. Beim Posten eines asynchronen SCM-Uploads wird die Aufgabe im Hintergrund verarbeitet. Sie müssen später erneut nachsehen, um den Status der Aufgabe anhand der zurückgegebenen Daten zu sehen.Aufgaben-ID. Prüfungen müssen möglicherweise mehrmals durchgeführt werden, wenn der Status der Aufgabe beispielsweise noch aussteht. Aufträge werden so schnell wie möglich bearbeitet, in arbeitsreichen Zeiten kann es jedoch zu Verzögerungen kommen.

Um den Status zu überprüfen, müssen Sie eine GET-Anfrage einrichten, indem Sie die folgende URL eingeben: https://api.scantrust.com/api/v2/scm/tasks/[task_id]/:

5. Anschließend können Sie den Aufgabenstatus überprüfen:

Es ist wichtig zu erwähnen, dass es mehrere Status geben kann: ausstehend, in Bearbeitung, abgeschlossen und fehlgeschlagen.

Synchrone SCM-Uploads​

Asynchrone SCM-Uploads​