本文介紹使用 Scantrust API 上傳和下載產品的步驟。首先,您需要一個具有下列權限的 UAT 令牌:
- 產品創建
- 產品刪除
- 產品編輯
- 產品視圖
您還需要在入口網站中設定至少一個品牌:您創建的每種產品都需要分配給一個品牌。
重要的:
若要存取 Scantrust REST API,您可以使用 API 平台,例如 Postman。 Postman 是全球最受歡迎的 API 平台,在全球擁有超過 1,700 萬用戶和 50 萬個組織。該工具提供靈活的協作環境,可讓您更快設計、開發、記錄和測試 API。
您可以嘗試 Web 應用程式或從此連結下載並安裝此應用程式:https://www.postman.com/downloads/。無論如何,您必須使用有效的電子郵件地址進行註冊。
注意:在 Scantrust 環境中,Postman 僅應用於測試目的,不適用於實際場景或專案實作。
設定 Postman 的步驟:
1. 請開啟Postman,在主頁上,您應該可以看到以下內容:
2. 然後,請點選左上角標示「工作區」的標籤:
3. 然後,請點選標示「我的工作區」的選項:
4. 進入工作區後,請點選「+」號,如下所示:
5. 之後,將出現一個新選項卡,其中包含預先配置的 API 請求:GET:
6. 現在,設定 API 授權非常重要。為此,請點擊「授權」標籤:
7. 然後,點選「類型」部分,選擇:「API金鑰」選項,如下:
8. 現在,在關鍵字欄位中輸入單字:“授權”,然後從 ST 入口網站複製您的 UAT 令牌並將其貼上到標記為“值”的欄位中,包括字元 UAT:UAT [你的代幣],在 UAT 字串和令牌之間留一個空格:
9.然後,轉到“Body”選項卡,選擇“raw”,然後選擇“JSON”:
使用 Scantrust API 上傳產品的步驟
1. 至此,您已準備好使用 Scantrust API 上傳產品。第一步,您必須將 API 請求變更為 POST。請點選請求按鈕並選擇“POST”選項:
2. 若要設定此請求,您必須輸入 URL,在本例中為:https://api.scantrust.com/api/v2/products/:
3. 然後,請在正文標籤上寫入以下內容:
{
"sku": "PR3",
「品牌」:2841,
"name": "產品三",
"description": "該系列產品中的第三款產品。",
"客戶端網址": "http://www.examplebrand.com/productone",
「活動」:575
}
其中 SKU 指的是公司內唯一的產品 SKU,品牌指的是品牌的 ID(整數)或參考號碼(字串),名稱指的是產品名稱。所有這些都是必填字段設定請求。
另一方面,描述欄位指的是產品的簡要描述;客戶端 URL 指的是產品 URL,如果該產品的廣告活動未激活,則可用於重定向程式碼;圖片欄位用於新增產品圖片,通常用於 STC 落地頁。如果未設定,則將使用品牌圖片;廣告活動 ID 指的是公司中現有廣告活動的 ID,必須將該產品新增至該廣告活動。所有這些都是可選字段。
4.完成程式碼腳本後,我們可以點擊發送按鈕:
5. 當產品成功發布後,回應如下:
如果上傳成功,狀態回應應該是 200 或 201。然後您可以在 Scantrust 入口網站上仔細檢查此新產品的建立。
使用 Scantrust API 下載產品的步驟
您將需要具有以下權限的 UAT 令牌:
- 產品視圖
在這種情況下,我們將僅使用產品 SKU 檢索整個公司或特定產品的產品資訊。
1. 請前往 Postman 中的工作區並開啟一個帶有「+」號的新分頁:
2. 然後,轉到“正文”選項卡,並選擇“無”:
3. 為了下載產品訊息,您必須透過輸入 URL 來設定 GET 請求,在本例中 URL 如下:https://api.scantrust.com/api/v2/products/:
4.然後,點選發送按鈕:
5.當API請求成功時,狀態回應應該是200,並且會給予回應:
此回應包括您公司的所有產品,具有特定屬性,例如 SKU、名稱、描述、品牌等。
6.如果想要了解具體的產品訊息,我們必須透過輸入URL來設定GET請求,在本例中URL如下:https://api.scantrust.com/api/v2/products/?sku_exact=[庫存單位]:
在這種情況下,回應僅包含您在 URL 上指明的 ID 的產品資訊.
评论