中移 - 中移认识---12.31 - 《ngari微服务模块（已离职停止更新）》

一、对接方式
- 页面跳转
接口对接：
二、网络要求
用户标签

家庭权益平台功能架构：

一、对接方式

支持三类对接方式：

页面跳转：由权益合作方提供H5页面及链接地址，内嵌到家庭权益平台前端页面。H5链接地址需配置渠道标识，并支持短链接跳转。
接口调用：接入方按照本规范提供https接口，支持家庭权益平台通过调用接口的方式向指定手机号发放权益内容。
兑换码：由权益方通过接口或者线下方式，提供家庭权益兑换码。兑换需要包含：权益名称、兑换码、兑换生效日期、兑换失效日期、批次等必要信息。
页面跳转
由权益合作方提供H5链接，内嵌到家庭权益平台前端页面。权益合作方H5链接地址需配置专属渠道标识，并支持短链接跳转。采用该接入方式，权益合作方必须与家庭权益平台实现单点登录，确保用户由家庭权益平台访问权益方H5页面过程中，无需二次登录，权益领取操作页面跳转不得超过2次。

接口对接：

1 权益发放接口

1.1 使用说明

接口方向：杭研家庭权益平台-> 第三方权益平台
接口说明：杭研家庭权益平台通过用户手机号等信息请求第三方权益平台，为用户发放制定的第三方权益。

1.2 接口地址

由第三方权益平台提供。

1.3 请求参数

参数	类型	是否必填	最大长度	描述	示例值
appid	String	是	35	家庭权益平台分配给业务平台的appid	mchvghsk4561221
sign	String	是	256	通过签名算法计算出的签名值，详见3.3.3	详见3.3.3
nonce_str	String	是	32	随机字符串	Yukivcnmbv
timestamp	String	是	30	时间戳，不得和家庭权益平台时间差超过3分钟	2020-02-01 00:00:00
trade_no	String	是	64	家庭会员平台订单号	736584365
user_phone	String	是	11	用户手机号，此号码为主账户	18899652236
product_id	String	是	30	权益id，由第三方权益平台提供	743657364583
channel_id	int	否	4	渠道id，由家庭权益平台分配，可以区分具体的调用渠道	2

1.4 请求样例

{
    "appid": "mchvghsk4561221",
    "sign": "xxx",
    "nonce_str": "Yukivcnmbv",
    "timestamp": "2020-02-01 00:00:00",
    "trade_no": "736584365",
    "user_phone": "18899652236",
    "produnct_id": "3453",
“channel_id”:2
}

1.5 响应参数

公共参数

参数	类型	是否必填	最大长度	描述	示例值
code	String	是	50	响应码，此字段是协议响应标识	SUCCESS，非SUCCESS时详见错误码
msg	String	否	256	响应码描述	return_code为非SUCCESS时存在，详见错误码
success	boolean	否	10	是否成功	true
data	Object	否		业务数据

业务参数，code为SUCCESS时存在。

参数	类型	是否必填	最大长度	描述	示例值
appid	String	是	35	家庭权益平台分配给业务平台的appid	mchvghsk4561221
sign	String	是	256	通过签名算法计算出的签名值，详见3.3.4	详见3.3.3
nonce_str	String	是	32	随机字符串	Yukivcnmbv
trade_no	String	是	64	家庭权益平台单号	7348654375
out_trade_no	String	是	64	第三方权益平台订单号	736584365

1.6 响应样例

{
    "code": "SUCCESS",
"success":true,
    "data": {
        "appid": "mchvghsk4561221",
        "sign": "xxx",
        "nonce_str": "Yukivcnmbv",
        "trade_no": "234354545"
        "out_trade_no": "1234354545"
    }
}

2 单点登录接口

2.1 使用说明

第三方平台提供单点登录url，比如为：https://ip/xxx/login，由家庭权益平台跳转至第三方平台是需带上token信息，即：https://ip/xxx/login?token=xxxxxxx。
通过杭研家庭权益平台单点登录到第三方权益平台，第三方权益平台根据传的token参数回调杭研家庭权益平台校验接口校验token，校验成功返回用户手机号信息。

2.2 接口地址

https://ip/cmccplus-openapi/user/login/check-token
请求参数

参数	类型	是否必填	最大长度	描述	示例值
appid	String	是	35	家庭权益平台分配给业务平台的appid	mchvghsk4561221
sign	String	是	256	通过签名算法计算出的签名值，详见3.3.3	详见3.3.3
nonce_str	String	是	32	随机字符串	Yukivcnmbv
timestamp	String	是	30	时间戳，不得和家庭权益平台时间差超过3分钟	2020-02-01 00:00:00
token	String	是	256	用户token	18899652236

2.3 请求样例

{
    "appid": "mchvghsk4561221",
    "sign": "xxx",
    "nonce_str": "Yukivcnmbv",
    "timestamp": "2020-02-01 00:00:00",
" token ": "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE1OTUzMTM5MjQsInN1YiI6IjE4ODY3MTAxMjE5IiwiaWF0IjoxNTk1MzEyMTI0NDgzfQ.TJ2jSBp-qESCyq8CWGxgjOSwCxtVY1tMDYSXujc84ovaAuvwHTDZsztUVskkJxkotUIbGlnBGxseNnR-GgSEJg"
}

2.4 响应参数

公共参数

参数	类型	是否必填	最大长度	描述	示例值
code	String	是	50	响应码，此字段是协议响应标识	SUCCESS，非SUCCESS时详见错误码
msg	String	否	256	响应码描述	return_code为非SUCCESS时存在，详见错误码
success	boolean	否	10	是否成功	true
data	Object	否		业务数据

业务参数，code为SUCCESS时存在。

参数	类型	是否必填	最大长度	描述	示例值
appid	String	是	35	家庭权益平台分配给业务平台的appid	mchvghsk4561221
sign	String	是	256	通过签名算法计算出的签名值，详见3.3.3	详见3.3.3
nonce_str	String	是	32	随机字符串	Yukivcnmbv
user_phone	String	是	11	用户手机号	13812121212

2.5 响应样例

{
    "code": "SUCCESS",
"success":true,
    "data": {
        "appid": "mchvghsk4561221",
        "sign": "xxx",
        "nonce_str": "Yukivcnmbv",
        "user_phone": "13812121212"
    }
}

3 兑换码对接

3.1 使用说明

建议权益方通过线下方式批量提供兑换码，如需接口对接，可单独约定对接方式。

3.2 兑换码字段要求

参数	名称	类型	说明
card_id	券码卡号	string	券码的卡号；唯一且英文字符和数字混排，长度10到16位。
code	券码卡密	string	券码的内容；唯一且英文字符和数字混排，长度9到18位；数据传输过程采用AES对称加密，详见数据加密。
expire_start	有效期开始时间	date	券码有效期的起始时间；如：2015-07-10
expire_end	有效期结束时间	date	券码有效期的结束时间；如：2015-08-09

二、网络要求

权益内容上线前，权益合作方需按照双方约定的对接方式（如：页面、接口、兑换码），提供上线资源对应的生产环境公网域名及IP地址，如相关资源已使用CDN加速，需提供可能分发到的全量IP地址信息，以免影响权益内容的兑付和使用。
权益合作方需将家庭权益平台使用的域名及出口IP段，添加到的白名单库并确保网络访问畅通。
以上网络信息如发生变更，权益合作方需提前三个工作日以书面或邮件方式正式通知杭研接口人。”

中移认识---12.31

一、 对接方式

页面跳转