跳到主要内容

接口 - 获取用户信息

接口名称：customer.info

请求参数​

{
    "paywall_id": "xxx",            // 付费界面ID，ID和别名传一个即可
    "paywall_alias": "",            // 付费界面别名，ID和别名传一个即可
    "extra_paywall_id": "",         // 可选，额外的付费界面ID
    "extra_paywall_alias": "",      // 可选，额外的付费界面别名
    "client_openid": ""             // 可选，微信支付AppID:OpenID，中间冒号分隔
    "customer": {
        "external_id": "",          // 商户系统用户ID
        "nickname": "",             // 商户系统用户用户名/昵称，可选
        "external_dt_created": "",  // 商户系统用户创建时间，可选
        "promoter": "xxxid-xxx"     // 推广员参数，可选
    },
    "include_balance": true         // 是否返回用户余额
}

参数说明：

  • 当使用微信支付从公众号、APP拉起微信付款场景时，client_openid 为必填项，格式为 AppID:OpenID，例如：wx1234567890:ox1234567890。

响应内容​

{
    "id": "13537457560670044000",  // 艺爪系统用户ID
    "external_id": "12345678",     // 商户系统用户ID
    "external_dt_created": "2022-06-01T06:58:18Z",  // 商户系统用户创建时间
    "nickname": "用户昵称",
    "balance_s": [                 // 余额信息
        {
            "equity": {            // 权益信息
                "id": "bd9nzdhnb8tvk",              // 权益ID
                "name": "会员",                      // 权益名称
                "alias": "equity_vip"               // 权益别名
            },
            "balance": 1654041600,                  // 到期时间或积分数量
            "balance_text": "2022-06-01T00:00:00Z", // 余额/到期时间字符串
            "is_balance_infinite": false,           // 是否永久或无限
            "is_balance_usable": true,              // 是否有余额/会员是否有效
            "has_charged": true,                    // 是否有效充值或兑换过
            "has_initial": true,                    // 是否用过试用会员
            "balance_log_id": "21"                  // 最后一次余额更新日志ID
        }
    ],
    "home_link": {            // 对应 paywall_id 和 paywall_alias
        "url": "",            // 付费页面链接，含用户登录凭证
        "promoter_url": ""    // 推广员页面链接，含用户登录凭证
    },
    "extra_link": {           // 对应 extra_paywall_id 和 extra_paywall_alias
        "url": "",            // 付费页面链接，含用户登录凭证
        "promoter_url": ""    // 推广员页面链接，含用户登录凭证
    },
    "dt_created": "2022-06-01T06:58:18Z",
    "dt_updated": "2022-06-01T06:58:18Z"
}

界面展示​

通过余额信息判断用户可享受的权益，并展示在页面上。

  1. is_balance_usable 判断会员是否有效/是否有余额。
  2. is_balance_infinite 用于展示永久/无限会员标识。
  3. has_charged 判断是否有效充值或兑换过/非试用会员，导入会员数据 也算有效充值。
  4. has_initial 判断是否用过试用会员。

对于「订阅/永久」类型的权益，balance 值为到期时间，用 Unix 时间戳整数表示，单位是秒，例如：1654041600 表示 2022-06-01T00:00:00Z。

对于「积分/消耗品」类型的权益，balance 值为积分数量。

balance_text 为会员到期时间(ISO8601格式)、积分数量字符串、或 ♾️ 符号。