文档中心 > API类目 > 五道口API

qimen.alibaba.wdk.member.identify (商家会员信息获取)

五道口商家开放会员接入,读取商家会员信息接口升级

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
memberParamDO MemberParamDO 必须 会员识别入参
  • └ accountId
  • String
  • 必须
  • 620100993
  • 根据类型,如果是cardNum,则是卡号,phoneNum对应手机号,mageticCard对应的磁卡的二轨信息,
  • └ accountType
  • String
  • 必须
  • cardNum
  • 会员卡的支持的查询方式,如卡号 则类型为 cardNum;如果是手机号,则是phoneNum;如果是磁卡,则是magneticCard。如果要支持绑卡,需要短信验证卡的归属,所以需要支持用手机号查询卡的信息
  • └ attributes
  • String
  • 可选
  • {"key": "value"}
  • 参数可选,因为会员是商家纬度,作为统计或者其他要求,会传商家的自有的店铺id,key storeId

响应参数

名称 类型 示例值 描述
memberResultDO MemberResultDO 会员信息获取结果
  • desAccount
  • DesAccount
  • 储值账户
  • └ currency
  • String
  • CNY
  • 币种,需符合ISO-4217标准
  • └ balance
  • Number
  • 1000
  • 余额,单位 分
  • scoreAccount
  • ScoreAccount
  • 积分账户
  • └ score
  • String
  • 100
  • 总积分
  • cardInfo
  • CardInfo
  • 卡信息
  • └ createTime
  • String
  • 2017-08-15 12:30:12
  • 发卡时间,格式:yyyy-MM-dd HH:mm:ss
  • └ endTime
  • String
  • 2017-08-15 12:30:12
  • 卡有效期截止日期,格式:yyyy-MM-dd HH:mm:ss;特别注意,如果有效期包含当前,则时分秒到当前的23时59分59s,如:2017-08-15 23:59:59
  • └ state
  • String
  • 使用中
  • ['使用中' or '已挂失' or '已作废' or '已补发卡' or '已退卡' or '已冻结' or '未激活' or '已坏卡登记' or '已销毁' or '已制卡' or '已发卡' or '已核对' or '已回收' or '空卡' or '异常' or '已损卡']: 卡状态
  • └ cardLevel
  • Number
  • 1
  • 卡的等级,从1开始,每增一级加1,高等级的会员意味着包含所有低等级的会员的权益,同一个商家的会员等级务必保证连续性
  • └ cardName
  • String
  • 普卡
  • 卡片名称
  • └ cardNum
  • String
  • 3344556
  • 卡号
  • └ forever
  • Boolean
  • true
  • 如果卡长期有效,值为true,为true时,默认不校验endTime
  • member
  • Member
  • 会员基础信息
  • └ name
  • String
  • 张三
  • 姓名
  • └ gender
  • String
  • female
  • 性别,['male' or 'female' or 'unknown']: 性别
  • └ address
  • String
  • 文一西路969号
  • 家庭常住地址
  • └ cellphone
  • String
  • 13888886666
  • 手机号,后续帮卡会做验证,尽可能保证正确性
  • └ email
  • String
  • xxx@qq.com
  • 邮件地址
  • └ birthday
  • String
  • 2017-08-15:12:30:12
  • 生日,格式:yyyy-MM-dd HH:mm:ss
  • └ province
  • String
  • 浙江省
  • 会员注册省份
  • └ city
  • String
  • 杭州市
  • 城市
  • └ district
  • String
  • 西湖区
  • └ lastUpdateTime
  • String
  • 2017-08-15:12:30:12
  • 最后更新时间,格式 yyyy-MM-dd HH:mm:ss
  • └ grade
  • String
  • 高级会员
  • 会员等级描述
  • idCard
  • IdCard
  • 证件信息
  • └ type
  • String
  • idCard
  • 证件类型,身份证:idCard;护照:passport;军人证:militaryCard; 其他:others
  • └ id
  • String
  • 3310881984034511223
  • 证件号
  • └ avatar
  • String
  • https://www.taobao.com
  • 头像信息
  • └ id
  • String
  • 1
  • 商家自有数据库id
  • └ attributes
  • String
  • {"key": "value"}
  • 其他可选自定义参数,固话(fixedPhone),卡类型(cardType),当前卡是否能被绑定(canBound:"0"/"1"),联名卡(cobrand),会员收银状态(memCashierType)
  • └ tips
  • String
  • {"key": "value"}
  • 会员提醒
errorCode String 1001 错误码,商家自定义
errorMessage String 会员卡不存在 错误信息,会最终返回到POS,方便问题排查,所以务必描述清楚
success Boolean false 请求是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaWdkMemberIdentifyRequest req = new AlibabaWdkMemberIdentifyRequest();
AlibabaWdkMemberIdentifyRequest.MemberParamDO obj1 = new AlibabaWdkMemberIdentifyRequest.MemberParamDO();
obj1.setAccountId("620100993");
obj1.setAccountType("cardNum");
obj1.setAttributes("{\"key\": \"value\"}");
req.setMemberParamDO(obj1);
AlibabaWdkMemberIdentifyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<memberResultDO>
    <desAccount>
        <currency>CNY</currency>
        <balance>1000</balance>
    </desAccount>
    <scoreAccount>
        <score>100</score>
    </scoreAccount>
    <cardInfo>
        <createTime>2017-08-15 12:30:12</createTime>
        <endTime>2017-08-15 12:30:12</endTime>
        <state>使用中</state>
        <cardLevel>1</cardLevel>
        <cardName>普卡</cardName>
        <cardNum>3344556</cardNum>
        <forever>true</forever>
    </cardInfo>
    <member>
        <name>张三</name>
        <gender>female</gender>
        <address>文一西路969号</address>
        <cellphone>13888886666</cellphone>
        <email>xxx@qq.com</email>
        <birthday>2017-08-15:12:30:12</birthday>
        <province>浙江省</province>
        <city>杭州市</city>
        <district>西湖区</district>
        <lastUpdateTime>2017-08-15:12:30:12</lastUpdateTime>
        <grade>高级会员</grade>
        <idCard>
            <type>idCard</type>
            <id>3310881984034511223</id>
        </idCard>
        <avatar>https://www.taobao.com</avatar>
    </member>
    <id>1</id>
    <attributes>{&quot;key&quot;: &quot;value&quot;}</attributes>
    <tips>{&quot;key&quot;: &quot;value&quot;}</tips>
</memberResultDO>
<errorCode>1001</errorCode>
<errorMessage>会员卡不存在</errorMessage>
<success>false</success>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
100
409
Ali_E202
http-service-status-error
-10001
9999
Ali_E201
isp.http-connection-timeout
10001
30003
5520
50001
50000
isp.http-read-timeout

API工具

如何获得此API

FAQ

返回
顶部