遍历产品

1. 请求地址：GET /products

2. 接口概述：

   遍历产品数据。

3. 请求参数：

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

   如何遍历？

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/products HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "productName": "软件保护产品",
                  "productGuid": "xxx",
                  "refId": "xxx",
                  "productVersion": "xxx"
              }
          ]
      }
   }

   响应体说明

查询产品

1. 请求地址： POST /products/data

2. 接口概述：

   根据指定条件查询产品。

3. 请求参数：

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

   如何遍历？

4. 请求体：

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

   如何查询？

   querys

   支持：productName，productGuid，refId。

   sorts

   支持：productName。

   参数说明

5. 请求示例：

   POST /bitanswer/api/products/data HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "querys": [
          {
              "name": "productName",
              "op": "like",
              "values": [
                  "Test%"
              ]
          }
      ],
      "sorts": [
          {
              "name": "productName"
          }
      ]
   }

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "productName": "Test",
                  "productGuid": "xxx"
              }
          ]
      }
   }

   响应体说明

添加产品

1. 请求地址：POST /products

2. 接口概述：

   根据产品名称查询产品：若不存在则添加产品并生成名为Default的默认模版；若存在则跳过。

3. 请求参数：

   无

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   productName	string	是	产品名称
   refId	string	否	引用ID	通常用于关联开发商的软件ID
   description	string	否	描述信息

   产品名称不能超过64个字符。

5. 请求示例：

   POST /bitanswer/api/products HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
     "productName" :"demo_product",
     "refId" :"113",
     "description" :"This is description."
   }

   参数说明

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "productName": "demo_product",
                  "productGuid": "xxxxxxxxxx",
                  "refId": "113",
                  "description": "This is description."
              }
          ]
      }
   }

   响应体说明

按产品名更新产品

1. 请求地址：

   • PATCH /products/{productName}

   • POST /products/{productName}

2. 接口概述：

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

   PATCH 方法仅更新输入的内容；

   POST 方法除输入的内容外，未输入的内容按默认值处理，适用于重置数据。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   productName	string	产品名	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   productName	string	否	产品名称	修改后的产品名
   refId	string	否	引用ID	通常用于关联开发商的软件ID
   description	string	否	描述信息

   参数说明

   产品名称不能超过64个字符。

5. 请求示例：

   PATCH /bitanswer/api/products/{productName} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••
   
   {
      "productName": "demo_product_1",
      "description": "修改描述"
   }

   参数说明

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "productName": "demo_product_1",
                  "description": "修改描述"
              }
          ]
      }
   }

   响应体说明

按产品名删除产品

1. 请求地址：DELETE /products/{productName}

2. 接口概述：

   删除指定名称的产品。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   productName	string	产品名	是

4. 请求体：

   无

5. 请求示例：

   DELETE /bitanswer/api/products/{productName} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

   参数说明

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "productName": "demo_product_1"
              }
          ]
      }
   }

   响应体说明

获取模块下载地址

1. 请求地址：GET /products/ref/{refId}/download_uri

2. 接口概述：

   根据产品的引用id查询指定的产品，获取指定产品的指定模块的下载地址。用户集成比特平台模块下载功能时使用。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   file_token	string	文件的token	是	联系比特安索获取文件token列表

   地址参数

   参数名	参数类型	参数说明	必需	备注
   refId	string	产品的引用id	是	为产品自定义的唯一id

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/products/ref/{refId}/download_uri?file_token={file_token} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "total": 1,
          "items": [
              {
                  "url": "指定模块的下载地址"
              }
          ]
      }
   }