工艺包加密 接口文档

Appearance

后台管理-工艺包 ​

创建工艺包 ​

类型 ​

POST

描述 ​

由管理员或者销售创建工艺包。

创建工艺包之后会默认创建一条版本为空的工艺包版本数据，此数据代表不限制版本。

请求地址 ​

txt
{{host}}/admin/bags/create

参数说明 ​

示例 ​

json
{
  "name": "自动码垛工艺包",
  "desc": "这是自动码垛工艺包的描述",
  "identifier": "stacking"
}

介绍 ​

参数位置类型说明
nameBodyString工艺包名称
descBodyString工艺包描述
identifierBodyString工艺包标识，上位机软件使用此标识确认具体是什么工艺包

权限说明 ​

🔒 需要带有 JWT 权限,示例：

txt
Authorization: Bearer {token}

返回值说明 ​

示例 ​

json
{
  "success": true,
  "msg": "OK"
}

解析 ​

参数类型说明
successBoolean此次请求是否成功
msgString返回的信息

查询工艺包 ​

类型 ​

GET

描述 ​

条件查询工艺包

请求地址 ​

txt
{{host}}/admin/bags/list

参数说明 ​

示例 ​

txt
{{host}}/admin/bags/list?page=1&per_page=10&sortby=createdAt&order=desc&id=7&uuid=2474C2E6-859E-4F36-9077-F4C7BE37DDA7&status=1&name=ddd

介绍 ​

参数位置类型说明
pageQueryString?当前页，默认 1
per_pageQueryString?每页数量，默认 10
sortbyQueryString?排序字段，可选 'id', 'createdAt', 'updatedAt'，默认 'id'
orderQueryString?升序降序，可选 'asc', 'desc'，默认 'asc'
idQueryNumber?条件查询： id
uuidQueryString?条件查询： uuid
statusQueryNumber?条件查询： 状态，可选 0（未废弃）, 1（已废弃） 默认 0
nameQueryString?条件查询： 名称

权限说明 ​

🔒 需要带有 JWT 权限,示例：

txt
Authorization: Bearer {token}

返回值说明 ​

示例 ​

json
{
  "success": true,
  "msg": "OK",
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "totalCount": 5,
    "totalPage": 1,
    "list": [
      {
        "id": 7,
        "uuid": "2474C2E6-859E-4F36-9077-F4C7BE37DDA7",
        "type": null,
        "status": 0,
        "name": "ddd2",
        "desc": "qwe",
        "jContent": null,
        "valid": 1,
        "version": 15,
        "createdAt": "2023-09-18T09:48:06.000Z",
        "updatedAt": "2023-09-19T03:33:42.000Z"
      },
      {
        "id": 9,
        "uuid": "C26CFFB1-C56C-41DE-A17F-D288A330699C",
        "type": null,
        "status": 0,
        "name": "ddd",
        "desc": "qwe",
        "jContent": null,
        "valid": 1,
        "version": 1,
        "createdAt": "2023-09-19T03:08:12.000Z",
        "updatedAt": "2023-09-19T03:08:12.000Z"
      },
      {
        "id": 10,
        "uuid": "FE79C246-7FB2-4368-A322-2642BB34E5FE",
        "type": null,
        "status": 0,
        "name": "ddd3",
        "desc": "qwe",
        "jContent": null,
        "valid": 1,
        "version": 1,
        "createdAt": "2023-09-19T04:28:24.000Z",
        "updatedAt": "2023-09-19T04:28:24.000Z"
      },
      {
        "id": 12,
        "uuid": "3E935CBF-695C-4693-90B9-C18631C6E1A4",
        "type": null,
        "status": 0,
        "name": "ddd5",
        "desc": "qwe",
        "jContent": null,
        "valid": 1,
        "version": 1,
        "createdAt": "2023-09-19T06:11:40.000Z",
        "updatedAt": "2023-09-19T06:11:40.000Z"
      },
      {
        "id": 13,
        "uuid": "94506FF8-B1AF-479C-B55B-45D63FA90A9F",
        "type": null,
        "status": 0,
        "name": "自动码垛工艺包",
        "desc": "这是自动码垛工艺包的描述",
        "jContent": null,
        "valid": 1,
        "version": 1,
        "createdAt": "2023-09-21T09:40:20.000Z",
        "updatedAt": "2023-09-21T09:40:20.000Z"
      }
    ]
  }
}

解析 ​

参数类型说明
successBoolean此次请求是否成功
msgString返回的信息
dataObjcet数据
data.currentPageNumber当前页
data.pageSizeNumber每页数据量
data.totalCountNumber总数
data.totalPageNumber总页数
data.listArray查询列表
data.list[n].idNumber工艺包 id
data.list[n].uuidString工艺包 uuid
data.list[n].statusNumber工艺包 状态
data.list[n].nameString工艺包 名称
data.list[n].descString工艺包 描述
data.list[n].[other]Any工艺包 其他信息

废弃工艺包 ​

类型 ​

PATCH

描述 ​

工艺包不允许修改和删除，错误的工艺包只能废弃处理。前台应该也支持查看已经废弃的工艺包。

废弃工艺包的同时，此接口会同时废弃掉工艺包下面的所有的工艺包版本，和通过这些版本创建的所有激活码。

这个接口建议前端做二次确认。

请求地址 ​

txt
{{host}}/admin/bags/abandon/uuid/:uuid

参数说明 ​

示例 ​

txt
{{host}}/admin/bags/abandon/uuid/2474C2E6-859E-4F36-9077-F4C7BE37DDA7

介绍 ​

参数位置类型说明
uuidParamString工艺包 UUID

权限说明 ​

🔒 需要带有 JWT 权限,示例：

txt
Authorization: Bearer {token}

返回值说明 ​

示例 ​

json
{
  "success": true,
  "msg": "OK"
}

解析 ​

参数类型说明
successBoolean此次请求是否成功
msgString返回的信息