跳转到内容

接口总览

商品目录就是 AI 肤质分析在做商品推荐时使用的那份商品清单。您的目录只需上传一次, 记下它的 catalog_id,把这个 id 传给测肤即可。目录会一直保留,直到您删除它。

目录归属于您的账号,不属于某一个 API 密钥:账号下的每个 API 密钥——包括项目密钥—— 看到的都是同一批目录;轮换密钥或删除密钥都不会影响它们。

上传与存储目录完全免费。

  • 目录文件
项目取值
格式带表头行的 CSV
编码UTF-8,带或不带字节顺序标记(BOM)皆可。Excel 的"CSV UTF-8"格式会带上 BOM。
文件大小上限5 MB
SKU 数量上限除文件大小外没有限制

必填栏位:

栏位说明
product_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。