SelSup Developers

公共的 API · 参考 API

产品标签

产品标签的终点,包括精确的路线,参数,请求机体和可扩展的响应方案.

9 终点/api/tag稳定机器可读的描述 ↗
{ }

通过可编辑的独立合同来支持本页面. 在生产使用之前,验证使用测试数据的写作操作.

/api/tag

准备使用的工作流程

准备使用的工作流程

01

开始使用产品标签

使用专用API代币,首先验证测试数据的读取操作.

  1. 保存代币服务器侧,然后将其发送到Authorization标题中.
  2. 检查所需参数,并扩大请求或响应方案.
  3. 在应用错误中处理HTTP状态和稳定的error字段.

数据模型

数据结构

模型在此列出一次,并且可以直接从使用它们的终端点扩展.

ProductTag3 字段
idinteger · int64

Id.

read-only
namestring

姓名.

必填
clientIdinteger · int64

客户身份证.

read-only
FindResponseProductTag1 字段
rowsProductTag[]

排列.

FindResponseProductTagInfo1 字段
rowsProductTagInfo[]

排列.

ProductTagInfo2 字段
productIdinteger · int64

产品身份证

productTagsProductTag[]

产品标签

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在error周围的应用逻辑,仅用于显示.

鱼类

稳定机器可读的代码用于集成逻辑.

鱼类

在API代币用户语言中显示准备的消息.

鱼类

服务器在本地化消息模板中插入的值.

localMessage使用了 API代币的用户的lang字段.文档语言和 Accept-Language标题不会改变它;当用户没有语言配置时,使用俄语.

RU用户位置是 ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
CN中文 (cn)
{
  "error": "error_brand_already_exists",
  "localMessage": "品牌 Base 已经存在",
  "params": {
    "name": "Base"
  }
}

终点

终点

PUT

更新标签

/api/tag/{tagId}
具有写入的标志

使用 PUT /api/tag/{tagId}. 更新标签

路径参数

字段类型必填描述
tagId integer · int64 标签身份证.

要求机构

application/json
对象场ProductTag
字段类型必填描述
id integer · int64 Id.
name string 姓名.
clientId integer · int64 客户身份证.
curl --request PUT 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

成功的反应

200
对象场 ProductTag
字段类型必填描述
id integer · int64 Id.
name string 姓名.
clientId integer · int64 客户身份证.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
错误7

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_tag_id_and_name_required
标签ID和名称是必填项

应用逻辑中使用稳定的error_tag_id_and_name_required代码;localMessage包含上述翻译.

400error_tag_id_required
标签ID是必填项

应用逻辑中使用稳定的error_tag_id_required代码;localMessage包含上述翻译.

400error_tag_update_failed
无法更新ID为: {0} 的标签

应用逻辑中使用稳定的error_tag_update_failed代码;localMessage包含上述翻译.

DELETE

更新标签 1

/api/tag/{tagId}
具有写入的标志

使用 DELETE /api/tag/{tagId}. 更新标签 1

路径参数

字段类型必填描述
tagId integer · int64 标签身份证.
curl --request DELETE 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200

答案没有身体.

错误3

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

PUT

绑定标签到产品

/api/tag/product/{tagId}/{productId}
具有写入的标志

使用 PUT /api/tag/product/{tagId}/{productId}. 绑定标签到产品

路径参数

字段类型必填描述
tagId integer · int64 标签身份证.
productId integer · int64 产品身份证
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200

答案没有身体.

错误6

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_duplicate_tag_association
标签已与产品关联。

应用逻辑中使用稳定的error_duplicate_tag_association代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_tag_and_product_id_required
需要标签和产品ID

应用逻辑中使用稳定的error_tag_and_product_id_required代码;localMessage包含上述翻译.

DELETE

连接标签到产品

/api/tag/product/{tagId}/{productId}
具有写入的标志

通过DELETE/api/tag/product/{tagId}/{productId}.将标签绑定到产品上

路径参数

字段类型必填描述
tagId integer · int64 标签身份证.
productId integer · int64 产品身份证
curl --request DELETE 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200

答案没有身体.

错误5

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_tag_and_model_id_required
标签ID和商品ID是必填项

应用逻辑中使用稳定的error_tag_and_model_id_required代码;localMessage包含上述翻译.

PUT

绑定标签到模型

/api/tag/model/{tagId}/{modelId}
具有写入的标志

使用 PUT /api/tag/model/{tagId}/{modelId}. 绑定标签到模型

路径参数

字段类型必填描述
tagId integer · int64 标签身份证.
modelId integer · int64 模型身份证.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200

答案没有身体.

错误6

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_duplicate_tag_association
标签已与产品关联。

应用逻辑中使用稳定的error_duplicate_tag_association代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_tag_and_model_id_required
标签ID和商品ID是必填项

应用逻辑中使用稳定的error_tag_and_model_id_required代码;localMessage包含上述翻译.

DELETE

结合标签与模型

/api/tag/model/{tagId}/{modelId}
具有写入的标志

通过DELETE/api/tag/model/{tagId}/{modelId}.进行模特的绑定标签

路径参数

字段类型必填描述
tagId integer · int64 标签身份证.
modelId integer · int64 模型身份证.
curl --request DELETE 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200

答案没有身体.

错误5

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_tag_and_model_id_required
标签ID和商品ID是必填项

应用逻辑中使用稳定的error_tag_and_model_id_required代码;localMessage包含上述翻译.

POST

创建标签

/api/tag
具有写入的标志

使用 POST /api/tag.创建标签

要求机构

application/json
对象场ProductTag
字段类型必填描述
id integer · int64 Id.
name string 姓名.
clientId integer · int64 客户身份证.
curl --request POST 'https://api.selsup.ru/api/tag' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

成功的反应

200
对象场 ProductTag
字段类型必填描述
id integer · int64 Id.
name string 姓名.
clientId integer · int64 客户身份证.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
错误6

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_duplicate_tag_name
已存在同名标签: {0}

应用逻辑中使用稳定的error_duplicate_tag_name代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_tag_name_required
标签名称是必填项

应用逻辑中使用稳定的error_tag_name_required代码;localMessage包含上述翻译.

GET

找到标签

/api/tag/find
读取访问的标志

使用 GET /api/tag/find. 找到标签

查询参数

字段类型必填描述
query string 问问.
productId integer · int64 产品身份证
limit integer · int32 限制.
page integer · int32 页面.
count boolean 伯爵.
sortBy stringID, NAME 排序了.
ascending boolean 升高.
curl --request GET 'https://api.selsup.ru/api/tag/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
对象场 FindResponseProductTag
字段类型必填描述
rows ProductTag[] 排列.
阵列项结构 ProductTag
字段类型必填描述
id integer · int64 Id.
name string 姓名.
clientId integer · int64 客户身份证.
{
  "rows": "string"
}
错误4

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

GET

找模型标签

/api/tag/find/{modelId}
读取访问的标志

使用 GET /api/tag/find/{modelId}. 找模型标签

路径参数

字段类型必填描述
modelId integer · int64 模型身份证.
curl --request GET 'https://api.selsup.ru/api/tag/find/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
对象场 FindResponseProductTagInfo
字段类型必填描述
rows ProductTagInfo[] 排列.
阵列项结构 ProductTagInfo
字段类型必填描述
productId integer · int64 产品身份证
productTags ProductTag[] 产品标签
阵列项结构 ProductTag
字段类型必填描述
id integer · int64 Id.
name string 姓名.
clientId integer · int64 客户身份证.
{
  "rows": "string"
}
错误4

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

Authorization

测试请求的标志

代币存储在本浏览器的本地存储库中,只会在要求的Authorization头上发送到 api.selsup.ru.

试一试

实际请求参数

现场API响应

发送请求查看SelSup的响应.