遍历所有产品

请求地址： GET /products

接口说明

  • 分页遍历所有产品

请求参数

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

请求示例

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

响应示例

{
    "status": 0,
    "data": {
        "items": [
            {
                "productName": "DEFAULT_AUDIENCE"
            },
            {
                "productName": "软件保护产品",
                "productGuid": "cf30e686a3646e0d3ef1ce23",
                "refId": "refId"
            }
        ]
    }
}

响应体参数说明

按条件检索产品

请求地址： POST /products/data

接口说明

  • 使用查询参数检索符合条件的产品

请求参数

  • Query
    参数名 类型 必需 示例值 说明
    offset integer 否 0 起始下标
    limit integer 否 50 范围（小于1000，默认50）
  • Body
    参数名 类型 必需 中文名
    querys array 否 查询条件
    sorts array 否 排序条件

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

参数名 类型 检索类型 必需 中文名
productName string query|sort 否 产品名称

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/products/data?offset=0&limit=3
bitkey: xxx
Content-Type: application/json

{
    "querys":[
        {
            "name":"productName",
            "op":"=",
            "values":[
                "demo"
            ]
        }
    ]
}

检索请求参数用法

响应示例

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

响应体参数说明

创建一个产品

请求地址： POST /products

接口说明

  • 创建一个产品，同时会自动创建一个名为Defalut的模板。
  • 创建成功后会返回刚刚创建的产品信息。

请求参数

  • Body
    参数名 类型 必需 中文名
    productName string 是 产品名
    refId string 否 产品引用id
    description string 否 产品描述

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/products
bitkey: xxx

{
   "productName" :"test_product_01",
   "refId" :"ProductRefId",
   "description" :"新建产品"
}

响应示例

{
    "status": 0,
    "data": {
        "total": 1,
        "items": [
            {
                "productName": "test_product_01",
                "productGuid": "d435334cffba41849f1142b543908df5",
                "refId": "ProductRefId",
                "description": "新建产品"
            }
        ]
    }
}

响应体参数说明

更新一个产品的全部信息

请求地址： POST /products/{productName}

接口说明

  • 完整更新一个产品的全部信息，更新产品名称时要求不能与已存在的产品重复。
  • 返回更新后的产品信息。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    productName string 是 product 产品名称

  • Body

    参数名 类型 必需 中文名
    productName string 是 产品名
    refId string 是 产品引用id
    description string 是 产品描述

请求示例

POST https://back-office-api.bitanswer.cn/bitanswer/api/products/demo
bitkey: xxx

{
  "productName": "foo",
  "refId": "boo",
  "description": "des"
}

响应示例

{
  "status": 0,
  "data": {
    "total": 1,
    "items": [
      {
        "productName": "foo",
        "refId": "boo",
        "description": "des"
      }
    ]
  }
}

响应体参数说明

更新一个产品

请求地址： PATCH /products/{productName}

接口说明

  • 更新一个产品的信息，更新产品名称时要求不能与已存在的产品重复。
  • 返回更新后的产品信息。

请求参数

  • Path

    参数名 类型 必需 示例值 说明
    productName string 是 product 产品名称

  • Body

    参数名 类型 必需 中文名
    productName string 否 产品名
    refId string 否 产品引用id
    description string 否 产品描述

请求示例

PATCH https://back-office-api.bitanswer.cn/bitanswer/api/products/foo
bitkey: xxx

{
  "refId": "boo-foo"
}

响应示例

{
  "status": 0,
  "data": {
    "total": 1,
    "items": [
      {
        "refId": "boo-foo"
      }
    ]
  }
}

响应体参数说明

删除一个产品

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

接口说明

  • 指定名称删除产品，要求产品名称存在。
  • 返回删除的产品名称。

请求参数

  • Path
    参数名 类型 必需 示例值 说明
    productName string 是 product 产品名称

请求示例

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

响应示例

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