生成授权码

请求地址： POST /sns/generate_sn

接口说明

• 根据产品、模版、业务批量生成授权码，同时可指定特征项和配置项属性。
• 授权码的属性在没有指定的情况下，继承自业务。

请求参数

• Query

  参数名	类型	必需	示例值	说明
  productName	string	是	product	产品名称
  templateName	string	是	template	模版名称
  businessName	string	是	business	业务名称
  count	integer	是	1	生成授权码数量（≤100）

• Body

  参数名	类型	必需	中文名
  startDate	string	否	起始日期
  endDate	string	否	结束日期
  volumeNumber	integer	否	终端限制
  expirationDays	integer	否	有效期天数
  usageNumber	integer	否	使用次数
  concurrentNumber	integer	否	并发数
  usersNumber	integer	否	用户数
  maxOfflineMinutes	integer	否	离线分钟数
  transferVolume	integer	否	浮动设备
  transferNumber	integer	否	转移次数
  vmDetect	boolean	否	虚拟机检测
  licenseBorrow	boolean	否	授权借出
  accessLog	boolean	否	用量统计
  ignoreUserLimit	boolean	否	忽略用户数
  distribution	boolean	否	授权分发
  readonly	boolean	否	授权只读
  features	array	否	特征项数组
  data	array	否	配置项数组

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/sns/generate_sn?productName=product&templateName=template2&businessName=business&count=1
bitkey: xxx
Content-Type: application/json

{
  "startDate": "2020-11-18 12:09:32",
  "endDate": "2021-05-01 10:51:19",
  "volumeNumber": 33,
  "expirationDays": 76,
  "usageNumber": 42,
  "concurrentNumber": 50,
  "usersNumber": 87,
  "maxOfflineMinutes": 28,
  "transferVolume": 82,
  "transferNumber": 71,
  "features": [
    {
      "id": 33,
      "name": "test_250007d75c94",
      "featureId": 53,
      "endDate": "2029-08-25 11:44:39",
      "expirationDays": 58,
      "users": 66,
      "value": 32,
      "version": "1",
      "source": "SN",
      "hidden": false,
      "overwrite": true
    }
  ],
  "data": [
    {
      "name": "test_02c7da447a30",
      "value": "test_a6ec6490fafc",
      "status": 78,
      "source": "SN"
    }
  ]
}

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "sn": "xxx",
                "status": 0,
                "startDate": "2005-12-31",
                "endDate": "2035-12-31",
                "updateTime": "2022-09-13",
                "regDate": "2022-09-13",
                "volumeNumber": 1,
                "expirationDays": 0,
                "usageNumber": 65536,
                "concurrentNumber": 1,
                "usersNumber": 0,
                "maxOfflineMinutes": 123,
                "transferVolume": 0,
                "transferNumber": 0
            }
        ]
    }
}

响应体参数说明

遍历所有授权码

请求地址： GET /sns

接口说明

• 分页遍历查询所有授权码。

请求参数

• Query

  参数名	类型	必需	示例值	说明
  offset	integer	否	0	起始下标
  limit	integer	否	50	范围（≤1000，默认50）

请求示例

GET https://back-office-api.bitanswer.cn/bitanswer/api/sns?offset=0&limit=2
bitkey: xxx

响应示例

{
    "status": 0,
    "data": {
        "total": 4,
        "items": [
            {
                "sn": "xxx",
                "activeDate": "2022-08-30",
                "status": 0,
                "updateTime": "2022-09-14",
                "regDate": "2022-08-30",
                "volumeNumber": 0,
                "expirationDays": 0,
                "usageNumber": 65536,
                "concurrentNumber": 1,
                "usersNumber": 10,
                "maxOfflineMinutes": 10,
                "transferVolume": 0,
                "transferNumber": 0
            },
            {
                "sn": "xxx",
                "lastUpdateDate": "2022-08-30",
                "activeDate": "2022-08-30",
                "status": 0,
                "updateTime": "2022-08-30",
                "regDate": "2022-08-30",
                "volumeNumber": 1,
                "expirationDays": 0,
                "usageNumber": 65536,
                "concurrentNumber": 1,
                "usersNumber": 0,
                "maxOfflineMinutes": 1000000000,
                "transferVolume": 0
            }
        ]
    }
}

响应体参数说明

按条件检索授权码

请求地址： POST /sns/data

接口说明

• 按条件查询授权码。

请求参数

• Query

  参数名	类型	必需	示例值	说明
  offset	integer	否	0	起始下标
  limit	integer	否	50	范围（≤1000，默认50）

• Body

  参数名	类型	必需	中文名
  querys	array	否	查询条件
  sorts	array	否	排序条件

支持的参数见下表，检索类型query表示可用于查询，sort表示可用于排序，query|sort表示可用于查询和排序。

参数名	类型	检索条件	必需	中文名
sn	string	query|sort	否	授权码
lastUpdateDate	string	query	否	最后更新时间
activeDate	string	query	否	激活时间
startDate	string	query	否	起始时间
endDate	string	query	否	结束时间
regDate	string	query	否	生成时间
type	string	query	否	授权类型(业务类型)

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/sns/data
bitkey: xxx
Content-Type: application/json

{
    "querys": [
        {
            "name": "sn",
            "op": "=",
            "values": [
                "xxx"
            ]
        }
    ]
}

检索请求参数用法

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "sn": "xxx",
                "status": 0,
                "startDate": "2023-11-09 00:00:00",
                "endDate": "2024-03-01 23:59:59",
                "updateTime": "2024-04-03 18:08:08",
                "regDate": "2023-11-09 14:44:44",
                "type": "CLOUD",
                "volumeNumber": 5,
                "expirationDays": 30,
                "usageNumber": 100,
                "concurrentNumber": 1,
                "usersNumber": 10,
                "maxOfflineMinutes": 1000000000,
                "transferVolume": 0,
                "transferNumber": 0,
                "vmDetect": false,
                "licenseBorrow": false,
                "accessLog": false,
                "ignoreUserLimit": false,
                "readonly": false,
                "distribution": false
            }
        ]
    }
}

响应体参数说明

查询一个授权码的信息

请求地址： GET /sns/{sn}

接口说明

• 查询一个授权码的信息。

请求参数

• Path

  参数名	类型	必需	示例值	说明
  sn	string	是	ABCDEFG123456	授权码

请求示例

GET https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxx
bitkey: your-key

响应示例

{
    "status": 0,
    "data": {
        "item": {
            "sn": "xxx",
            "status": 0,
            "startDate": "2023-11-09 00:00:00",
            "endDate": "2024-03-01 23:59:59",
            "updateTime": "2024-04-03 18:08:08",
            "regDate": "2023-11-09 14:44:44",
            "type": "CLOUD",
            "volumeNumber": 5,
            "expirationDays": 30,
            "usageNumber": 100,
            "concurrentNumber": 1,
            "usersNumber": 10,
            "maxOfflineMinutes": 1000000000,
            "transferVolume": 0,
            "transferNumber": 0,
            "vmDetect": false,
            "licenseBorrow": false,
            "accessLog": false,
            "ignoreUserLimit": false,
            "readonly": false,
            "distribution": false
        }
    }
}

响应体参数说明

批量更新授权码全部信息

请求地址： POST /sns

接口说明

• 批量更新授权码，覆盖所有信息。

请求参数

• Body

  参数名	类型	必需	中文名
  sn	string	是	授权码
  lastUpdateDate	string	是	更新时间
  activeDate	string	是	激活时间
  status	integer	是	状态
  startDate	string	是	起始日期
  endDate	string	是	结束日期
  updateTime	string	是	更新时间
  regDate	string	是	生成时间
  volumeNumber	integer	是	终端限制
  expirationDays	integer	是	有效期天数
  usageNumber	integer	是	使用次数
  concurrentNumber	integer	是	并发数
  usersNumber	integer	是	用户数
  maxOfflineMinutes	integer	是	离线分钟数
  transferVolume	integer	是	浮动设备
  transferNumber	integer	是	转移次数

注：请求体需以数组形式输入。

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/sns
bitkey: xxx
Content-Type: application/json

[
    {
        "sn": "xxx",
        "lastUpdateDate": "2031-03-11 06:25:46",
        "activeDate": "2019-10-26 10:09:05",
        "status": 57,
        "startDate": "2029-06-09 04:10:22",
        "endDate": "2028-08-25 22:30:52",
        "updateTime": "2023-08-05 10:27:46",
        "regDate": "2029-11-29 06:34:43",
        "volumeNumber": 96,
        "expirationDays": 96
    }
]

响应示例

{
    "status": 0,
    "data": {
        "total": 2,
        "items": [
            {
                "sn": "xxx",
                "lastUpdateDate": "2022-09-08",
                "activeDate": "2003-07-19",
                "status": 57,
                "startDate": "2029-06-09",
                "endDate": "2028-08-25",
                "updateTime": "1970-02-05",
                "regDate": "2022-04-14",
                "volumeNumber": 96,
                "expirationDays": 96
            }
        ]
    }
}

响应体参数说明

批量更新授权码

请求地址： PATCH /sns

接口说明

• 批量更新授权码。

请求参数

• Body

  参数名	类型	必需	中文名
  sn	string	否	授权码
  lastUpdateDate	string	否	更新时间
  activeDate	string	否	激活时间
  status	integer	否	状态
  startDate	string	否	起始日期
  endDate	string	否	结束日期
  updateTime	string	否	更新时间
  regDate	string	否	生成时间
  volumeNumber	integer	否	终端限制
  expirationDays	integer	否	有效期天数
  usageNumber	integer	否	使用次数
  concurrentNumber	integer	否	并发数
  usersNumber	integer	否	用户数
  maxOfflineMinutes	integer	否	离线分钟数
  transferVolume	integer	否	浮动设备
  transferNumber	integer	否	转移次数

注：请求体需以数组形式输入。

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/sns
bitkey: xxx
Content-Type: application/json

[
    {
        "sn": "xxx",
        "lastUpdateDate": "2031-03-11 06:25:46",
        "activeDate": "2019-10-26 10:09:05",
        "status": 57,
        "startDate": "2029-06-09 04:10:22",
        "endDate": "2028-08-25 22:30:52",
        "updateTime": "2023-08-05 10:27:46",
        "regDate": "2029-11-29 06:34:43",
        "volumeNumber": 96,
        "expirationDays": 96
    }
]

响应示例

{
    "status": 0,
    "data": {
        "total": 2,
        "items": [
            {
                "sn": "xxx",
                "lastUpdateDate": "2022-09-08",
                "activeDate": "2003-07-19",
                "status": 57,
                "startDate": "2029-06-09",
                "endDate": "2028-08-25",
                "updateTime": "1970-02-05",
                "regDate": "2022-04-14",
                "volumeNumber": 96,
                "expirationDays": 96
            }
        ]
    }
}

响应体参数说明

更新一个授权码

请求地址： PATCH /sns/{sn}

接口说明

• 更新授权码的属性。

请求参数

• Path

  参数名	类型	必需	示例值	说明
  sn	string	是	ABCDEFG123456	授权码

• Body

  参数名	类型	必需	中文名
  sn	string	否	授权码
  lastUpdateDate	string	否	更新时间
  activeDate	string	否	激活时间
  status	integer	否	状态
  startDate	string	否	起始日期
  endDate	string	否	结束日期
  updateTime	string	否	更新时间
  regDate	string	否	生成时间
  volumeNumber	integer	否	终端限制
  expirationDays	integer	否	有效期天数
  usageNumber	integer	否	使用次数
  concurrentNumber	integer	否	并发数
  usersNumber	integer	否	用户数
  maxOfflineMinutes	integer	否	离线分钟数
  transferVolume	integer	否	浮动设备
  transferNumber	integer	否	转移次数

注意：请求体中的SN会被请求路径的SN替换，不会作为修改目标。

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxx
bitkey: xxx
Content-Type: application/json

{
  "startDate": "2020-01-18",
  "endDate": "2011-04-17",
  "volumeNumber": 65,
  "expirationDays": 29,
  "usageNumber": 8,
  "concurrentNumber": 70,
  "usersNumber": 63,
  "maxOfflineMinutes": 66,
  "transferVolume": 33,
  "transferNumber": 16
}

响应示例

{
    "status": 0,
    "data": {
        "item": {
            "sn": "xxx",
            "activeDate": "2022-09-02",
            "status": 0,
            "startDate": "2005-12-31",
            "endDate": "2035-12-31",
            "updateTime": "2022-09-02",
            "regDate": "2022-09-02",
            "volumeNumber": 1,
            "expirationDays": 0,
            "concurrentNumber": 1,
            "usersNumber": 0,
            "maxOfflineMinutes": 1000000000,
            "transferVolume": 0,
            "transferNumber": 0
        }
    }
}

响应体参数说明

批量删除授权码

请求地址： DELETE /sns

接口说明

• 批量删除授权码。

请求参数

• Body

  参数名	类型	必需	中文名
  sns	array	否	授权码列表

注：请求体需以数组形式输入。

请求示例

DELETE https://back-office-api.bitanswer.cn/bitanswer/api/sns'
bitkey: xxx
Content-Type: application/json

["sn", "sn"]

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "sn": "xxx"
            }
        ]
    }
}

删除一个授权码

请求地址： DELETE /sns/{sn}

接口说明

• 删除指定的授权码。

请求参数

• Path

  参数名	类型	必需	示例值	说明
  sn	string	是	ABCDEFG123456	授权码

请求示例

DELETE https://back-office-api.bitanswer.cn/bitanswer/api/sns/xxx
bitkey: xxx

响应示例(data)

{
    "status": 0,
    "data": {
        "items": [
            {
                "sn": "xxx"
            }
        ]
    }
}