遍历用户

  1. 请求地址:GET /sns/{sn}/users

  2. 接口概述:

    遍历指定授权码关联的用户。

  3. 请求参数:

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

    如何遍历?

    地址参数

    参数名 参数类型 参数说明 必需 备注
    sn string 授权码
  4. 请求体:

  5. 请求示例:

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

    {
       "status": 0,
       "data": {
           "total": 2,
           "items": [
               {
                   "nickName": "nick_name_1",
                   "name": "login_name_1",
                   "guid": "xxxxx1",
                   "regDate": "2023-11-03 13:35:01",
                   "status": 0
               },
               {
                   "nickName": "nick_name_2",
                   "name": "login_name_2",
                   "guid": "xxxxx2",
                   "regDate": "2023-11-07 17:59:12",
                   "status": 0
               }
           ]
       }
    }

    响应体说明

查询用户

  1. 请求地址: POST /sns/{sn}/users/data

  2. 接口概述:

    根据指定条件查询指定授权码关联的用户。

  3. 请求参数:

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

    如何遍历?

  4. 请求体:

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

    如何查询?

    querys

    支持:name

    sorts

    支持:name

    参数说明

  5. 请求示例:

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

    {
       "status": 0,
       "data": {
           "total": 2,
           "items": [
               {
                   "nickName": "unittest_account1",
                   "name": "unittest_account1",
                   "guid": "xxxxx1",
                   "regDate": "2023-11-03 13:35:01",
                   "status": 0
               },
               {
                   "nickName": "unittest_account2",
                   "name": "unittest_account2",
                   "guid": "xxxxx2",
                   "regDate": "2023-11-07 17:59:12",
                   "status": 0
               }
           ]
       }
    }

    响应体说明

批量关联用户

  1. 请求地址:POST /sns/{sn}/users

  2. 接口概述:

    查询指定授权码,根据帐号查询指定的用户进行绑定。

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    sn string 授权码
  4. 请求体:

    参数名 参数类型 参数说明 必需 备注
    name string 帐号

    请求体以数组形式输入。

  5. 请求示例:

    PATCH /bitanswer/api/sns/{sn}/users HTTP/1.1
    Host: back-office-api.bitanswer.cn
    Content-Type: application/json
    bitkey: ••••••
    
    [
       {
           "name":"login_name_1"
       },
       {
           "name":"login_name_2"
       }
    ]
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 2,
           "items": [
               {
                   "sn": "xxxxx",
                   "name": "login_name_1"
               },
               {
                   "sn": "xxxxx",
                   "name": "login_name_2"
               }
           ]
       }
    }

    响应体说明

批量解绑用户

  1. 请求地址:DELETE /sns/{sn}/users

  2. 接口概述:

    查询指定授权码,批量解绑用户。

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    sn string 授权码
  4. 请求体:

    参数名 参数类型 参数说明 必需 备注
    name string 帐号 name和guid至少存在一个
    guid string 用户唯一标识符 name和guid至少存在一个

    请求体以数组形式输入。

  5. 请求示例:

    DELETE /bitanswer/api/sns/{sn}/users HTTP/1.1
    Host: back-office-api.bitanswer.cn
    Content-Type: application/json
    bitkey: ••••••
    
    [
       {
           "name":"login_name_1"
       },
       {
           "name":"login_name_2"
       }
    ]
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 2,
           "items": [
               {
                   "sn": "xxxxx",
                   "name": "login_name_1"
               },
               {
                   "sn": "xxxxx",
                   "name": "login_name_2"
               }
           ]
       }
    }

    响应体说明

授权码绑定指定用户

  1. 请求地址:POST /sns/{sn}/users/user/{name}

  2. 接口概述:

    为指定授权码绑定指定的用户。

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    sn string 授权码
    name string 帐号
  4. 请求体:

  5. 请求示例:

    POST /bitanswer/api/sns/{sn}/users/user/{name} HTTP/1.1
    Host: back-office-api.bitanswer.cn
    bitkey: ••••••
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 1,
           "items": [
               {
                   "sn": "xxxxx",
                   "name": "login_name"
               }
           ]
       }
    }

授权码解绑指定用户

  1. 请求地址:DELETE /sns/{sn}/users/{name}

  2. 接口概述:

    为指定授权码解绑指定的用户。

  3. 请求参数:

    地址参数

    参数名 参数类型 参数说明 必需 备注
    sn string 授权码
    name string 客户名
  4. 请求体:

  5. 请求示例:

    DELETE /bitanswer/api/sns/{sn}/users/{name} HTTP/1.1
    Host: back-office-api.bitanswer.cn
    bitkey: ••••••
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 1,
           "items": [
               {
                   "sn": "xxxxx",
                   "name": "login_name"
               }
           ]
       }
    }