SelSup Developers

公共的 API · 参考 API

约伯

工作的终点,包括精确的路线,参数,请求机构和可扩展的响应方案.

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

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

/api/job

准备使用的工作流程

准备使用的工作流程

01

开始使用Job

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

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

数据模型

数据结构

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

Job11 字段
idinteger · int32

Id.

namestring

姓名.

categoryClassstring

类别类.

clientIdinteger · int64

客户身份证.

deletedboolean

删除了.

positionIdinteger · int64

位置身份.

versionIdinteger · int64

版本ID.

createdUserstring

创建用户.

createdDatestring · date-time

创造日期.

pricenumber · double

价格.

tariffsJobTariff[]

关税.

JobTariff8 字段
idinteger · int64

Id.

jobIdinteger · int32

工作身份证.

pricenumber · double

价格.

brandIdinteger · int32

品牌身份证.

categoryClassstring

类别类.

categoryIdinteger · int32

类别的ID.

priorityinteger · int32

优先考虑.

productIdinteger · int64

产品身份证

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在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/job/{jobId}
具有写入的标志

通过PUT/api/job/{jobId}. 输入工作

路径参数

字段类型必填描述
jobId integer · int64 工作身份证.

要求机构

application/json
对象场Job
字段类型必填描述
id integer · int32 Id.
name string 姓名.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
clientId integer · int64 客户身份证.
deleted boolean 删除了.
positionId integer · int64 位置身份.
versionId integer · int64 版本ID.
createdUser string 创建用户.
createdDate string · date-time 创造日期.
price number · double 价格.
tariffs JobTariff[] 关税.
阵列项结构 JobTariff
字段类型必填描述
id integer · int64 Id.
jobId integer · int32 工作身份证.
price number · double 价格.
brandId integer · int32 品牌身份证.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
categoryId integer · int32 类别的ID.
priority integer · int32 优先考虑.
productId integer · int64 产品身份证
curl --request PUT 'https://api.selsup.ru/api/job/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}'

成功的反应

200
对象场 Job
字段类型必填描述
id integer · int32 Id.
name string 姓名.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
clientId integer · int64 客户身份证.
deleted boolean 删除了.
positionId integer · int64 位置身份.
versionId integer · int64 版本ID.
createdUser string 创建用户.
createdDate string · date-time 创造日期.
price number · double 价格.
tariffs JobTariff[] 关税.
阵列项结构 JobTariff
字段类型必填描述
id integer · int64 Id.
jobId integer · int32 工作身份证.
price number · double 价格.
brandId integer · int32 品牌身份证.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
categoryId integer · int32 类别的ID.
priority integer · int32 优先考虑.
productId integer · int64 产品身份证
{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}
错误14

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_empty_category_class
没有指定等级

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

400error_empty_job_price
未指定的价格做工作

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

400error_empty_position
未注明位置

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

400error_empty_tariff_price
税号{position}没有注明价格。

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

400error_empty_tariff_priority
对关税号{position}不给予优先权。

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

400error_empty_tariffs
没有规定关税

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

400error_job_already_exists
一个名为 {jobName} 的工作已经存在

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

400error_job_modified
工作数据已被更新。刷新页面。

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

400error_job_tariff_wrong_product_id
项目ID不正确: {id}。

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

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

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

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

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

DELETE

移除约伯

/api/job/{jobId}
具有写入的标志

使用 DELETE /api/job/{jobId}. 删除工作

路径参数

字段类型必填描述
jobId integer · int32 工作身份证.

查询参数

字段类型必填描述
deleted boolean 删除了.
curl --request DELETE 'https://api.selsup.ru/api/job/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
"string"
错误6

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_job_modified
工作数据已被更新。刷新页面。

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

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

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

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

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

POST

职位工作

/api/job/
具有写入的标志

使用 POST /api/job/. 发布工作

要求机构

application/json
对象场Job
字段类型必填描述
id integer · int32 Id.
name string 姓名.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
clientId integer · int64 客户身份证.
deleted boolean 删除了.
positionId integer · int64 位置身份.
versionId integer · int64 版本ID.
createdUser string 创建用户.
createdDate string · date-time 创造日期.
price number · double 价格.
tariffs JobTariff[] 关税.
阵列项结构 JobTariff
字段类型必填描述
id integer · int64 Id.
jobId integer · int32 工作身份证.
price number · double 价格.
brandId integer · int32 品牌身份证.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
categoryId integer · int32 类别的ID.
priority integer · int32 优先考虑.
productId integer · int64 产品身份证
curl --request POST 'https://api.selsup.ru/api/job/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}'

成功的反应

200
对象场 Job
字段类型必填描述
id integer · int32 Id.
name string 姓名.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
clientId integer · int64 客户身份证.
deleted boolean 删除了.
positionId integer · int64 位置身份.
versionId integer · int64 版本ID.
createdUser string 创建用户.
createdDate string · date-time 创造日期.
price number · double 价格.
tariffs JobTariff[] 关税.
阵列项结构 JobTariff
字段类型必填描述
id integer · int64 Id.
jobId integer · int32 工作身份证.
price number · double 价格.
brandId integer · int32 品牌身份证.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS 类别类.
categoryId integer · int32 类别的ID.
priority integer · int32 优先考虑.
productId integer · int64 产品身份证
{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}
错误12

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_empty_category_class
没有指定等级

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

400error_empty_job_price
未指定的价格做工作

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

400error_empty_position
未注明位置

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

400error_empty_tariff_price
税号{position}没有注明价格。

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

400error_empty_tariff_priority
对关税号{position}不给予优先权。

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

400error_empty_tariffs
没有规定关税

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

400error_job_already_exists
一个名为 {jobName} 的工作已经存在

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

400error_job_tariff_wrong_product_id
项目ID不正确: {id}。

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

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

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

Authorization

测试请求的标志

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

试一试

实际请求参数

现场API响应

发送请求查看SelSup的响应.