SelSup Developers

公共的 API · 参考 API

关键词

关键词的终点,包括精确的路线,参数,请求机体和可扩展的响应方案.

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

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

/api/keyword

准备使用的工作流程

准备使用的工作流程

数据模型

数据结构

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

Keyword3 字段
idinteger · int64

Id.

namestring

姓名.

usingQuantityinteger · int32

通过量.

KeywordGroup3 字段
idinteger · int64

Id.

namestring

姓名.

keywordsKeyword[]

关键词.

KeywordAndGroup2 字段
keywordKeyword[]

关键词.

groupKeywordGroup[]

集团.

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在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"
  }
}

终点

终点

GET

获取群体的关键词

/api/keyword/group/{groupId}
读取访问的标志

使用 GET /api/keyword/group/{groupId}.获取从组中关键字

路径参数

字段类型必填描述
groupId integer · int64 组身份证.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
对象场 KeywordGroup
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

PUT

按ID编辑关键字组

/api/keyword/group/{groupId}
具有写入的标志

使用PUT/api/keyword/group/{groupId}.编辑按ID的关键字组

路径参数

字段类型必填描述
groupId integer · int64 组身份证.

查询参数

字段类型必填描述
newName string 新名字.

要求机构

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

成功的反应

200
对象场 KeywordGroup
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

DELETE

删除关键词组

/api/keyword/group/{groupId}
具有写入的标志

使用 DELETE /api/keyword/group/{groupId}.删除关键字组

路径参数

字段类型必填描述
groupId integer · int64 组身份证.
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
对象场 KeywordGroup
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

PUT

添加关键词组

/api/keyword/add
具有写入的标志

使用 PUT 添加关键字组

查询参数

字段类型必填描述
productId integer · int64 产品身份证
productViewId integer · int64 产品查看ID.
modelId integer · int64 模型身份证.

要求机构

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/add' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

成功的反应

200

答案没有身体.

错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

GET

获取关键词组

/api/keyword/group
读取访问的标志

使用 GET /api/keyword/group.获取关键字组

curl --request GET 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
阵列项结构 KeywordGroup[]
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
[
  "string"
]
错误4

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

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

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

POST

创建关键词组

/api/keyword/group
具有写入的标志

使用 POST 创建关键字组

查询参数

字段类型必填描述
groupName string 组名

要求机构

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group?groupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

成功的反应

200
对象场 KeywordGroup
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

DELETE

删除关键词组

/api/keyword/group
具有写入的标志

使用 DELETE /api/keyword/group.删除关键词组

要求机构

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

成功的反应

200
"string"
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

POST

合并关键词组

/api/keyword/group/merge
具有写入的标志

使用 POST 合并关键词组

查询参数

字段类型必填描述
newGroupName string 组名.

要求机构

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group/merge?newGroupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

成功的反应

200
对象场 KeywordGroup
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
错误7

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_empty_group_name
关键字组的名称不能为空

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

400error_empty_keywords_groups
关键字组为空

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

400error_need_at_least_two_groups
至少需要两个分组

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

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

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

GET

找一个实体的关键词

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

使用 GET /api/keyword/{modelId}.获取实体的关键字

路径参数

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

成功的反应

200
对象场 KeywordAndGroup
字段类型必填描述
keyword Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
group KeywordGroup[] 集团.
阵列项结构 KeywordGroup
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
{
  "keyword": "string",
  "group": "string"
}
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

GET

找关键词组

/api/keyword/group/find
读取访问的标志

使用 GET 找到关键字组

查询参数

字段类型必填描述
word string 听说了.
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
阵列项结构 KeywordGroup[]
字段类型必填描述
id integer · int64 Id.
name string 姓名.
keywords Keyword[] 关键词.
阵列项结构 Keyword
字段类型必填描述
id integer · int64 Id.
name string 姓名.
usingQuantity integer · int32 通过量.
[
  "string"
]
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

DELETE

从实体中删除关键词组

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

使用 DELETE /api/keyword/model/{modelId}.删除关键字组

路径参数

字段类型必填描述
modelId integer · int64 模型身份证.

要求机构

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/model/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

成功的反应

200
"string"
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

DELETE

删除从组中关键字

/api/keyword/group/{groupId}/keywords
具有写入的标志

使用 DELETE /api/keyword/group/{groupId}/keywords. 从组删除关键字

路径参数

字段类型必填描述
groupId integer · int64 组身份证.

要求机构

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001/keywords' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

成功的反应

200
"string"
错误3

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

Authorization

测试请求的标志

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

试一试

实际请求参数

现场API响应

发送请求查看SelSup的响应.