关注

如何透過 Scantrust API 上傳 SCM 數據

要將 SCM 資料上傳到 Scantrust API,Scantrust 支援兩種方法,同步非同步每種方法都有其限制和優點。在選擇最適合您用例的方法之前,請務必了解它們之間的差異。

同步 SCM 上傳

同步上傳資料時,API 會在 HTTP 呼叫期間處理並更新您的所有資料。如果發送了大量資料或更新了大量程式碼,此方法可能會逾時,需要重新發送請求。因此,同步更新方法僅適用於低資料量

非同步 SCM 上傳

當非同步上傳資料時,API 將建立一個後台作業來更新您的資料並立即回應任務ID, 這任務ID可用於檢查作業狀態(待處理、正在運作、錯誤…)

在同步和非同步之間進行選擇

由於同步更新可以立即回應,因此設定起來最簡單。然而,它只建議在更新代碼數量較少(少於 1000 個)的情況下使用。而當 SCM 更新需要使用非同步方法時,您的整合必須重新檢查任務ID了解 SCM 更新的結果。

重要的

要上傳數據,無論是透過同步或非同步方法,您都需要具有以下權限的 UAT 令牌:

  • 程式碼視圖
  • scm_bulk_edit
  • scm_code_edit
  • 產品視圖

此外,務必確保:

  • 您在 Scantrust 入口網站上擁有品牌擁有者/SCM 使用者角色:
  • 已設定為包含所需 SCM 欄位的廣告活動。範例:
    • 生產日期、預期市場、RFID、...
    • 注意:未包含在活動中的 SCM 欄位將被系統丟棄。
  • 針對包含在活動中且具有待更新的有效代碼的產品的工作訂單。

若要存取 Scantrust REST API,您可以使用 Postman 等 API 平台。這是全球最受歡迎的 API 平台,在全球擁有超過 1700 萬用戶和 50 萬個組織。該工具提供靈活的協作環境,讓您能夠更快地設計、開發、記錄和測試 API。

您可以嘗試 Web 應用程式或從此連結下載並安裝此應用程式:https://www.postman.com/downloads/。無論如何,您必須使用有效的電子郵件地址進行註冊。

注意:在 Scantrust 環境中,Postman 僅應用於測試目的,不應用於實際場景或專案實作。 

配置 Postman 的步驟

1. 請開啟 Postman。在主頁上,您應該能夠看到以下內容:

Picture1.png

2. 然後,轉到左上角標有「工作區」的選項卡。

3. 點選選項:「我的工作區」:

4. 進入工作區後,請點選「+」號,如下所示:

5. 之後,將出現一個帶有預先配置 API 請求的新選項卡:

 

6.現在,設定 API 授權非常重要。為此,請點擊標記為「授權」的選項卡:

7.然後,點選「類型」部分,選擇:「API金鑰」選項,如下:

Picture7.png

8. 現在,在關鍵字欄位中輸入單字:“授權”,然後從 ST 入口網站複製您的 UAT 令牌並將其貼上到標記為“值”的欄位中,包括字元 UAT:UAT [你的代幣],在 UAT 字串和令牌之間留一個空格:

Picture8.png

9.然後,轉到“Body”選項卡,選擇“raw”,然後選擇“JSON”:

Picture9.png

上傳 SCM 的步驟 - 同步

資料必須使用 JSON 格式上傳。該 API 將接受批量項目不大於100每次調用。因此,每次 POST 請求必須將資料拆分成最多 100 個項目的批次。建議保留一個日誌文件,其中包含先前上傳項目的鍵/批次號,以便在上傳時跳過這些項目。這可以防止 API 在特定批次中攔截到有缺陷的項目時導致項目重複上傳。

1. 若要設定此 POST 請求,您必須輸入 URL,在本例中為:https://api.scantrust.com/api/v2/scm/上傳

mceclip0.png

2. 然後,在 body 標籤上,您必須設定 JSON,如下例所示:

{
"data_key": "extended_id",
"專案": 
[
{"extended_id": "HGDTQD54D5SD86EEDFS", "intended_market": "cn"},
{“extended_id”:“JF5FPO58DFITE4EDXD2”,“intended_market”:“de”}
]
}

其中,必須選擇“data_key”來選擇要上傳資料的程式碼。有兩種方法可以確定密鑰:

  • 預設情況下,該鍵將擴充 ID(每個代碼都包含唯一的資訊)。
  • 也可以將鍵設為序號如果它們設定在代碼上。

此外,「項目」指的是以鍵/值對形式呈現的 SCM 資料列表,用於上傳到各個程式碼。每個資料鍵都需要引用行銷活動中定義的 SCM 欄位的鍵。您可以透過從行銷活動的 SCM T&T 標籤下載 template.csv 檔案來確認鍵的名稱。

3. 完成程式碼腳本後,我們可以點擊「發送」按鈕。

mceclip2.png

4. 成功發布一批最多 100 個代碼後,系統會傳回一個包含受影響代碼和已發佈代碼的回應。收到回應後,您將收到:

mceclip1.png

5. 最後但同樣重要的一點是,您可以在 Scantrust 入口網站的「代碼交易」部分檢查這些代碼是否受到此更新的影響:

mceclip3.png

在這種情況下,對於特定代碼,我們將 intended_market 欄位更新為中國。

上傳 SCM 的步驟 - 非同步

與同步過程類似,重要的是要確保:

  • Scantrust 入口網站上的品牌擁有者/SCM 使用者帳戶:
  • 設定為包含所需 SCM 欄位的行銷活動:
    • 例如:production_date、intended_market、RFID、...
    • 注意:未包含在活動中的 SCM 欄位將被系統丟棄。
  • 針對包含在活動中且具有待更新的有效代碼的產品的工作訂單。

資料必須使用 JSON 格式上傳。 API 最多接受 5 個約束,每個約束包含 1K 個值。資料必須拆分成包含相同 SCM 資料的批次。建議保留一個日誌文件,其中包含先前上傳項目的鍵/批次號,以便在上傳時跳過這些項目。這可以防止 API 在特定批次中攔截到有缺陷的項目時導致項目重複上傳。

1. 若要設定此 POST 請求,您必須輸入 URL,在本例中為:https://api.scantrust.com/api/v2/scm/上傳/異步/

mceclip4.png

向此端點發布資料將建立一個非同步伺服器作業,該作業可以編輯您公司中的任何程式碼以包含所需的 SCM 資料。該端點將會傳回任務ID可用於檢查作業的狀態。

2. 然後,在 body 標籤上,您必須設定 JSON,如下所示:

{
「約束」:{
“extended_id”:[“ACsofByKKTvj”,”Bjr1U5dt3M8X”,“JKZlcPU6Za4q”]
},
“scm_數據”:{
"purchase_number": "test19102022"
},
“參考”:“SCM上傳”
}

「約束」必須包含要上傳資料所需的程式碼,「scm_data」應包含要更新的欄位及其值。

3. 完成程式碼腳本後,我們可以點擊「發送」按鈕。

mceclip2.png

4. 請求成功後,結果中將顯示 200 OK 回應。此外,API 還將返回任務ID可用於查找工作狀態:

mceclip0.png

5. 提交非同步 SCM 上傳時,任務將在背景處理。您需要稍後根據傳回的資訊查看任務狀態。任務ID例如,如果任務狀態仍為待處理,則可能需要多次檢查。作業將盡快處理,但在繁忙時段可能會出現延遲。

若要檢查狀態,您需要輸入以下 URL 來設定 GET 請求:https://api.scantrust.com/api/v2/scm/tasks/[task_id]/

mceclip1.png

5.然後,您可以檢查任務狀態:

mceclip2.png

值得一提的是,可能有幾種狀態:待定、進行中、完成和失敗。

这篇文章有帮助吗?
0 人中有 0 人觉得有帮助
还有其它问题?提交请求

评论