富士通会员系统VIPax api 接入手册
version 2.2
20180927
富士通信息技术有限公司
2018-8
目录
富士通会员系统VIPax api 接入手册 .................................................... 1
1.
引言 3
1.1 编写目的 ................................................................... 3
1.2 读者对象 ................................................................... 3
1.3 术语定义 ................................................................... 3
2.
调用说明 ........................................................................ 3
2.1 固定请求地址 ............................................................... 3
2.2 请求报文说明 ............................................................... 3
3.
会员接口 ........................................................................ 4
3.1 更新会员信息 ............................................................... 4
3.2 查询会员信息 ............................................................... 5
3.3 会员储值消费 ............................................................... 8
3.4 会员储值消费接口(线下POS用) ............................................. 10
3.5 查询交易流水 .............................................................. 11
4.
订单接口 ....................................................................... 13
4.1 提交订单 .................................................................. 13
4.1.1 调用实例 ............................................................ 14
4.2 退货订单上传 .............................................................. 14
4.2.1 调用实例 ............................................................ 15
5.
商品接口 ....................................................................... 15
5.1 获取商品SKU 库存 ........................................................... 16
1.
引言
1.1 编写目的
文档描述了富士通会员VIPax系统开放接口。合作伙伴可以通过这些开放接口与富士通会员VIPax系统实现
数据互通。
1.2 读者对象
1, 富士通会员VIPax系统内部技术开发人员。
2, 富士通会员VIPax系统合作伙伴技术对接人员。
1.3 术语定义
缩写、术语
解 释
商户
入驻富士通会员VIPax系统平台的客户,都会获得商户账号。商户可作为总品
牌,在总品牌下
新建子品牌。每个品牌都会对应一个品牌(商户)code;
门店
VIPax平台中的门店为线上门店,实际对应于商户/子品牌的实体门店,门店存
在
商户/子品牌下面;
商户 code/门店 code
code 信息在VIPax平台的门店管理模块中维护;
2.
调用说明
2.1 固定请求地址
测试环境地址:
接口地址:http://47.99.51.145:8889/VipaxWS/ws
appid :f93fb45f-ed25-466a-9215-d0d93a809f98
secret :2194BE12F45556DDE33E8139C1CC5518
测试会员卡号:MEMB20180810000004
测试会员手机号:13961618173
正式环境地址:
邮件联络
2.2 请求报文说明
请求报文由下面几个 key/value 组成,请求方式为 post 或 get:
appid:由富士通会员VIPax系统提供,对接方的标识
。
ts:时间戳。时间戳格式为:yyyyMMddHHmmss。
v:请求 api 的版本号,当前版本值为 2.0。
sign: 签 名 。 对 下 面 字 符 串 进 行 md5 签 名 (32 位 ):
appid+secret+ts+v
secret
由富士通会员VIPax系统提供,
model:业务名称。
method:具体业务方法名称。
msg:业务数据格式为 json。
请求报文需要使用 URL Encode。
响应报文,响应格式为 json:
code:1 表示成功,其他详见错误码表。
msg:响应消息,code 为 1 时“成功”。
result:业务数据返回,详见接口业务返回数据。
3.
会员接口
3.1 更新会员信息
请求参数: model=customer&method=update
请求报文 msg 内容:
参数
数据类型
属性
说明
user_id
String(32)
与other_id,open_id,mobile
不能同时为空
会员 id
other_id
String(32)
与 user_id,open_id,mobile
不能同时为空
其他系统 ID
vip_no
String(32)
会员卡号
level_name
string
等级名称
union_id
String(32)
union_id
brandId
String(32)
多品牌商户使用同一个 appid
时必填
品牌 id
birthday
String(32)
生日 格式 yyyy-MM-dd
createTime
String
注册时间 格式: yyyy-MM-dd
HH:mm:ss
logo
String(256)
会员头像
nick_name
String(32)
昵称
mobile
String(11)
与
user_id,open_id,other_id
不能同时为空
会员手机号码
openid
String(32)
与user_id,other_id,mobile
不能同时为空
微信 openid
vip_offline_no
String(20)
关联实卡(线下会员卡卡号)
vip_name
String(32)
姓名
vip_sex
String(10)
性别 1 男 2 女
city_code
String(6)
城市代码
store_code
String(32)
门店代码
detail_add
String(50)
详细地址
password
String
设置的密码,MD5 加密值
props
array
自定义字段
props 内容:
参数
数据类型
属性
说明
storePropId
String(32)
字段 id
value
String(32)
字段值
user_id,other_id 必须有一项非空,以此两项查找会员更新其他信息。user_id 优先级高于 other_id。
响应报文 result:空。
3.2 查询会员信息
请求参数: model=customer&method=get
请求报文 msg 内容:
参数
数据类型
属性
说明
vip_no
String(32)
会员卡号
mobile
String(11)
会员手机号码
openid
String(32)
微信 openid
store_code
String(32)
非空
门店 code
user_id
String(32)
用户 Id(customerId)
other_id
String
其他系统会员标识
mobile 或 vip_no 或 openid 或 user_id 或 other_id 不能同时为空
响应报文 result: