来伊份授权
1. 前言:
为规范来伊份对接的三方应用获取用户信息方式,现发布来伊份标准授权流程。应用于第三方应用使用H5页面形式嵌入来伊份APP时获取用户信息的场景。
来伊份会为每一个接入的应用或者商户分配一个appId和密钥。使用appId和密钥调用来伊份开放接口。
2. 交互时序图:
进入第三方页面后,如果需要获取用户信息,可以与来伊份APP或者H5交互获取lyfcode。在APP环境中和H5环境中,都提供了获取lyfcode的方式。
- 在来伊份APP的环境中时:
var getLyfCode = {
"function": "getLyfCode",
"param": {
//appid
"appid": "123456789qwer2345"
},
//结果回调,{"code":"1","data":"lyfcode"}
// code==1 成功返回,code ==2 用户拒绝, code==-1 非法appid
"callback": "callresult"
}
- 在H5环境中时:
- 第三方活动页跳转进授权页必须在链接上带上参数appId和uri,uri是授权完成后使用者需要回跳的页面url,示例:
测试环境:https://m.test.laiyifen.com/lyf/author?appId=${this.appId}&uri=${encodeURIComponent(uri)}
生产环境:https://m.laiyifen.com/lyf/author?appId=${this.appId}&uri=${encodeURIComponent(uri)} - 授权流程结束回跳到uri后,"lyfcode"放在链接上作为参数回传,第三方将页面链接decodeURI后获取“lyfcode”后,进行后续交互。
lyfcode作为授权获取到的凭证,10分钟内有效且只能使用一次。获取到lyfcode之后,由服务端调用来伊份服务端使用lyfcode获取用户信息(昵称、头像、性别等)和用户在第三方appId下的唯一用户Id:lyfuid。其他接口均使用lyfuid作为用户唯一标识与来伊份的接口进行调用。
3. 请求场景:
获取到lyfcode后获取用户信息
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | lyf-user |
URL | 生产环境:https://openapi.laiyifen.com/lyf-user/auth/info 测试环境:https://openapi.test.laiyifen.com/lyf-user/auth/info |
认证方式 | 令牌 |
请求方式 | HTTP(POST) |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
lyfcode | String | 是 | 同与前端交互获取的lyfcode |
5.4 入参示例
{"lyfcode": "JAHroywu2yJqXJKrT7Q/KEJIxLEAjrWZuOgzR+cvSutHI0FIDkxg=="}
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
lyfuid | String | 是 | 来伊份lyfuid,商户授权用户id |
gender | Long | 是 | 性别(0-保密,1-男,2-女) |
headUrl | Integer | 是 | 头像地址 |
nickName | String | 是 | 用户昵称 |
employee | String | 是 | 是否在职员工 |
newUser | String | 是 | 是否新用户(注册14天内且没有发生过交易的用户) |
registerTime | String | 是 | 注册时间 |
vipLevel | String | 是 | 会员等级 |
paidMember | String | 是 | 是否是黑金会员 |
5.7 返回示例
{
"data":{
"lyfuid":"2BBFA5XXXXXXXXXXXXXXXXXX89E90",
"nickName":"来伊份",
"headUrl":"https://static4.laiyifen.com/files/guide/image/b3xxxxxxx03.jpg",
"vipLevel":1,
"registerTime":"1999-12-08 05:30:12",
"gender":1,
"newUser":false,
"employee":true,
"paidMember":true
},
"code":"0",
"msg":"success"
}