遍历业务

  1. 请求地址:GET /businesses

  2. 接口概述:

    遍历业务数据。

  3. 请求参数:

    参数名 参数类型 参数说明 必需 备注
    offset integer 响应结果起始下标 默认0
    limit integer 响应结果的数量 默认50,最大1000

    如何遍历?

  4. 请求体:

  5. 请求示例:

    GET /bitanswer/api/businesses?limit=1 HTTP/1.1
    Host: back-office-api.bitanswer.cn
    bitkey: ••••••
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 5,
           "items": [
               {
                   "guid": "xxx",
                   "name": "foo",
                   "type": "FLOAT",
                   "description": "boo"
               }
           ]
       }
    }

    响应体说明

查询业务

  1. 请求地址: POST /businesses/data

  2. 接口概述:

    根据指定条件查询业务。

  3. 请求参数:

    参数名 参数类型 参数说明 必需 备注
    offset integer 响应结果起始下标 默认0
    limit integer 响应结果的数量 默认50,最大1000

    如何遍历?

  4. 请求体:

    参数名 参数类型 参数说明 必需 备注
    querys array 查询参数
    sorts array 排序参数

    如何查询?

    querys

    支持:nameguidtype

    sorts

    支持:name

    参数说明

  5. 请求示例:

    POST /bitanswer/api/businesses/data HTTP/1.1
    Host: back-office-api.bitanswer.cn
    Content-Type: application/json
    bitkey: ••••••
    
    {
       "querys": [
           {
               "name": "name",
               "op": "=",
               "values": [
                   "Test"
               ]
           }
       ],
       "sorts": [
           {
               "name": "name"
           }
       ]
    }
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 1,
           "items": [
               {
                   "guid": "xxx",
                   "name": "foo",
                   "type": "GROUP"
               }
           ]
       }
    }

    响应体说明

添加业务

  1. 请求地址:POST /businesses

  2. 接口概述:

    添加业务数据(该接口不支持创建帐号授权2.0业务)。

  3. 请求参数:

  4. 请求体:

    参数名 参数类型 参数说明 必需 备注
    name string 业务名称 业务名称不能超过64个字符
    businessOs string 业务操作系统 业务操作系统:DEFAULT:全平台,WINDOWSPC_LINUXMACOSANDROIDARM_LINUXIOSMIPSLinuxUNIXQNXHARMONY
    type string 业务类型 业务类型:CLOUD:云,WEB_APP:帐号授权,LOCAL:单机,FLOAT:单机浮动,GROUP:集团授权,BIT_IDBIT_ID_FLOAT:Bit-ID浮动授权,BIT_ID_GROUP:Bit-ID集团,DEMO:演示,TRY:试用,PRE:预授权,USB:U盘授权,BATCH:批量授权,ANDROID:安卓授权
    description string 业务说明
    controlType string 授权方式 授权方式:ONLINE:在线,OFFLINE:离线,SMART:智能
    volumeNumber integer 终端限制
    startDate string 起始日期否 yyyy-MM-dd HH:mm:ss
    endDate string 结束日期 yyyy-MM-dd HH:mm:ss
    expirationDays integer 有效期
    usageNumber integer 使用次数
    concurrentNumber integer 并发数
    usersNumber integer 用户数
    maxOfflineMinutes integer 强制认证
    maxTotalMinutes integer 运行时间
    downloadNumber integer 安装限制
    transferVolume integer 浮动机器
    transferNumber integer 转移次数
    vmDetect boolean 虚拟机检测
    forbidRemoteDesktop boolean 远程桌面检测
    licenseBorrow boolean 授权借出
    earlyReturn boolean 提前返还
    redundant boolean 冗余检查
    mute boolean 不可升级
    preClient boolean 设备有效期
    preLicense boolean 预授权
    localOnly boolean 仅限本机访问
    denyActivation boolean 阻止新激活
    namedUser boolean 帐号授权
    accessLog boolean 用量统计
    distribution boolean 授权分发
    agent boolean 多级服务
    ignoreUserLimit boolean 忽略用户数
    allReUpdate boolean 重用升级码
    readonly boolean 授权只读
    uploadPeak boolean 峰值上传
    allowSplit boolean 允许拆分
    denyContainer boolean 容器检测
    bindingBitId boolean 绑定比特ID
  5. 请求示例:

      POST /bitanswer/api/businesses?limit=1 HTTP/1.1
      Host: back-office-api.bitanswer.cn
      bitkey: ••••••
    
      {
          "name":"demo_business",
          "businessOs":"WINDOWS",
          "type":"CLOUD",
          "description": "This is description."
      }
  6. 响应示例:

      {
          "status": 0,
          "data": {
              "total": 1,
              "items": [
                  {
                      "controlType": "ONLINE",
                      "concurrentNumber": 1,
                      "usersNumber": 1,
                      "transferVolume": 0,
                      "transferNumber": 0,
                      "guid": "xxxxxxxxxx",
                      "name": "demo_business",
                      "type": "CLOUD",
                      "businessOs": "WINDOWS",
                      "description": "This is description.",
                      "regDate": "2025-09-18 16:44:04"
                  }
              ]
          }
      }

    响应体说明

查询指定业务

  1. 请求地址:GET /businesses/{businessName}

  2. 接口概述:

    查询指定业务的信息。

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    businessName string 业务名
  4. 请求体:

  5. 请求示例:

      GET /bitanswer/api/businesses/{businessName} HTTP/1.1
      Host: back-office-api.bitanswer.cn
      bitkey: ••••••
  6. 响应示例:

      {
          "status": 0,
          "data": {
              "total": 1,
              "items": [
                  {
                      "controlType": "ONLINE",
                      "concurrentNumber": 1,
                      "usersNumber": 1,
                      "transferVolume": 0,
                      "transferNumber": 0,
                      "guid": "xxxxxxxxxx",
                      "name": "demo_business",
                      "type": "CLOUD",
                      "businessOs": "WINDOWS",
                      "description": "This is description.",
                      "regDate": "2025-09-18 16:44:04"
                  }
              ]
          }
      }

    响应体说明

按业务名更新业务

  1. 请求地址:

    • PATCH /businesses/{businessName}

    • POST /businesses/{businessName}

  2. 接口概述:

    通过地址参数上的业务名查询指定产品,修改业务的信息。

    PATCH 方法用于部分更新数据,仅对请求中明确输入的内容进行修改,其他内容保持原有值不变。

    POST 方法用于全量重置数据,会以请求中输入的内容覆盖原有值,未输入内容则被置为空值。(不推荐用于部分更新数据,易导致未输入数据被误清空)

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    businessName string 业务名
  4. 请求体:

    参数名 参数类型 参数说明 必需 备注
    name string 业务名称 业务名称不能超过64个字符
    description string 业务说明
    controlType string 授权方式 授权方式:ONLINE:在线,OFFLINE:离线,SMART:智能
    volumeNumber integer 终端限制
    startDate string 起始日期否 yyyy-MM-dd HH:mm:ss
    endDate string 结束日期 yyyy-MM-dd HH:mm:ss
    expirationDays integer 有效期
    usageNumber integer 使用次数
    concurrentNumber integer 并发数
    usersNumber integer 用户数
    maxOfflineMinutes integer 强制认证
    maxTotalMinutes integer 运行时间
    downloadNumber integer 安装限制
    transferVolume integer 浮动机器
    transferNumber integer 转移次数
    vmDetect boolean 虚拟机检测
    forbidRemoteDesktop boolean 远程桌面检测
    licenseBorrow boolean 授权借出
    earlyReturn boolean 提前返还
    redundant boolean 冗余检查
    mute boolean 不可升级
    preClient boolean 设备有效期
    preLicense boolean 预授权
    localOnly boolean 仅限本机访问
    denyActivation boolean 阻止新激活
    namedUser boolean 帐号授权
    accessLog boolean 用量统计
    distribution boolean 授权分发
    agent boolean 多级服务
    ignoreUserLimit boolean 忽略用户数
    allReUpdate boolean 重用升级码
    readonly boolean 授权只读
    uploadPeak boolean 峰值上传
    allowSplit boolean 允许拆分
    denyContainer boolean 容器检测
    bindingBitId boolean 绑定比特ID
  5. 请求示例:

      PATCH /bitanswer/api/businesses/{businessName} HTTP/1.1
      Host: back-office-api.bitanswer.cn
      bitkey: ••••••
    
      {
          "name": "new_business_name",
          "description": "修改描述"
      }
  6. 响应示例:

      {
          "status": 0,
          "data": {
              "total": 1,
              "items": [
                  {
                      "controlType": "ONLINE",
                      "concurrentNumber": 1,
                      "usersNumber": 1,
                      "transferVolume": 0,
                      "transferNumber": 0,
                      "guid": "xxxxxxxxxx",
                      "name": "new_business_name",
                      "type": "CLOUD",
                      "businessOs": "WINDOWS",
                      "description": "修改描述",
                      "regDate": "2025-09-18 16:44:04"
                  }
              ]
          }
      }

    响应体说明

按业务名删除业务

  1. 请求地址:DELETE /businesses/{businessName}

  2. 接口概述:

    删除指定名称的业务。业务下存在SN时删除会报错。

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    businessName string 业务名
  4. 请求体:

  5. 请求示例:

      DELETE /bitanswer/api/businesses/{businessName} HTTP/1.1
      Host: back-office-api.bitanswer.cn
      bitkey: ••••••
  6. 响应示例:

      {
          "status": 0,
          "data": {
              "total": 1,
              "items": [
                  {
                      "name": "demo_business"
                  }
              ]
          }
      }

    响应体说明