查询授权码绑定的客户

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

  2. 接口概述:

    查询指定授权码绑定的客户。

  3. 请求参数:

    地址参数

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

  5. 请求示例:

    GET /bitanswer/api/sns/{sn}/customers HTTP/1.1
    Host: back-office-api.bitanswer.cn
    Content-Type: application/json
    bitkey: ••••••
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 1,
           "items": [
               {
                   "name": "unit_customer",
                   "description": "description",
                   "regDate": "2024-08-14 17:25:46",
                   "address": "beijing"
               }
           ]
       }
    }

    响应体说明

授权码绑定客户

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

  2. 接口概述:

    更新授权码绑定的客户。客户若不存在则新建客户(并关联指定的客户组),将客户与授权码进行绑定。一个授权码只能关联一个客户,数组只支持传一个客户实体。

  3. 请求参数:

    地址参数

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

    参数名 参数类型 参数说明 必需 备注
    name string 客户名称
    groupName string 客户组名
    description string 说明
    officeNumber string 电话
    mobileNumber string 手机
    email string 邮件地址
    address string 地址
    city string 城市
    country string 国家/地区
    postcode string 邮政编码
    contact string 联系人
    referenceId string 编号

    参数说明

    请求体以数组形式输入。

  5. 请求示例:

    POST /bitanswer/api/sns/{sn}/customers HTTP/1.1
    Host: back-office-api.bitanswer.cn
    Content-Type: application/json
    bitkey: ••••••
    
    [
       {
           "name":"unit_customer",
           "description":"description",
           "address":"beijing"
       }
    ]
  6. 响应示例:

    {
       "status": 0,
       "data": {
           "total": 1,
           "items": [
               {
                   "name": "unit_customer",
                   "description": "description",
                   "address": "beijing"
               }
           ]
       }
    }

    响应体说明

授权码绑定指定客户

  1. 请求地址:

    • POST /sns/{sn}/customers/name/{name}
    • POST /sns/{sn}/customers/name/{group_name}/{name}
  2. 接口概述:

    给指定授权码绑定(指定客户组下的)指定的客户。

  3. 请求参数:

    地址参数

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

  5. 请求示例:

    给指定授权码绑定指定的客户:

    POST /bitanswer/api/sns/{sn}/customers/name/{name} HTTP/1.1
    Host: back-office-api.bitanswer.cn
    bitkey: ••••••

    给指定授权码绑定指定客户组下的指定的客户:

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

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

授权码解绑指定客户

  1. 请求地址:

    • DELETE /sns/{sn}/customers/name/{name}

    • DELETE /sns/{sn}/customers/name/{group_name}/{name}

  2. 接口概述:

    解除指定授权码绑定的(指定客户组下的)指定客户名称的客户。

  3. 请求参数:

    地址参数

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

  5. 请求示例:

    解除指定授权码绑定的指定客户名称的客户:

    DELETE /bitanswer/api/sns/{sn}/customers/name/{name} HTTP/1.1
    Host: back-office-api.bitanswer.cn
    Content-Type: application/json
    bitkey: ••••••

    解除指定授权码绑定的指定客户组下的指定客户名称的客户:

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

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