跳转到内容

端點總覽

產品目錄是 AI 肌膚檢測用於產品推薦的產品清單。上傳您的目錄 一次,保留其 catalog_id,並將該 id 傳給肌膚檢測。目錄會保留到您刪除為止。

目錄屬於您的帳號,而非單一 API key:帳號中的所有 API key(包含專案 key)都能看見 相同的目錄,輪換或刪除 key 不會影響它們。

上傳與儲存目錄是免費的。

  • 目錄檔案
項目值
格式含標題列的 CSV
編碼UTF-8,可含或不含位元組順序標記(BOM)。Excel 的「CSV UTF-8」格式會加入 BOM。
最大檔案大小5 MB
最大 SKU 數量除檔案大小外無限制

必要欄位:

欄位說明
product_id您的產品 id
product_name產品名稱
product_description產品說明

其他欄位會被忽略,但仍計入 5 MB 限制。含逗號或換行的值必須 加引號,如同標準 CSV。每個非空的資料列計為一個 SKU。

範例:

product_id,product_name,product_description
SKU-001,Hydrating Serum,"A lightweight serum for dry skin."
SKU-002,Brightening Cream,"Evens out skin tone, for daily use."
  • 目錄狀態
狀態意義可用於肌膚檢測
ready已上傳並通過驗證是
failed已上傳,但檔案驗證失敗否

驗證失敗的上傳會回傳錯誤,並仍被記錄為 failed 目錄,在「列出目錄」中可見。 像刪除其他目錄一樣刪除它。

  • 限制

每個帳號最多可保留 10 個目錄,ready 與 failed 一計計算。上傳新的目錄前請先刪除一個。

要更新目錄,請上傳新檔案:每次上傳都會建立新的 catalog_id,舊目錄在您刪除前仍可使用, 因此您可以在切換前先檢查新的目錄。

  • 刪除

刪除目錄是立即且永久的。自那一刻起,所有使用其 catalog_id 的肌膚檢測呼叫 都會失敗。已刪除的目錄無法恢復;再次上傳相同的檔案會建立一個新的目錄, 帶有新的 catalog_id。