文档简介：
1.APP获取授权手机号
Path：/oauth-api/oauth/getMobilePhoneV2/{userId}/{appId}
Method：POST
接口描述：获取授权手机号
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
|
|
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
|
用户ID,由SDK初始化时获取 |
| appId |
|
申请的应用ID |
Body
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| token | string | 必须 | SDK获取到的一键登录token |
| sign | string | 必须 | 通过appSecret生成签名.(规则为: userId + appId + token + appSecret; md5 32位小写加密4次,不包括加号) |
返回数据
成功案例
{
"msg": "success",
"code": 200,
"data": {
"mobile": "QjqJ/hJxGiAMnmFuAu05wHoZP2ADc5D5Si9vRtUAhg+i35euwJxgRKB0H8MpqwwEhTIGLxJe0xQ/Ex
AlvF0oVbPwSenaIKM6cGIzGf+GsvN1jXU2Sz10bacyo+md9B79RYg8S+GvwmXV9LEwnY9BDloOnFjYO9N+oYt6S+0odPc="
}
}复制
失败案例
{"msg":"参数解密失败","code":300}复制
注 : mobile为加密后的手机号，需要使用RSA进行解密。(工具类请参考“一键登录服务端工具类”)
2.H5获取授权手机号
Path：/oauth-api/oauth/getMobilePhoneH5V2/{userId}/{appId}
Method： POST
接口描述：获取授权手机号
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 用户ID,由SDK初始化时获取 | |
| appId | 申请的应用ID |
Body
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| token | string | 必须 | SDK获取到的一键登录token |
| userInformation | string | 必须 | 浏览器指纹 |
| sign | string | 必须 | 通过appSecret生成签名.(规则为: userId + appId + token + appSecret; md5 32位小写加密4次,不包括加号) |
返回数据
成功案例
{
"msg": "success",
"code": 200,
"data": {
"mobile": "QjqJ/hJxGiAMnmFuAu05wHoZP2ADc5D5Si9vRtUAhg+i35euwJxgRKB0H8MpqwwEhTIGL
xJe0xQ/ExAlvF0oVbPwSenaIKM6cGIzGf+GsvN1jXU2Sz10bacyo+md9B
79RYg8S+GvwmXV9LEwnY9BDloOnFjYO9N+oYt6S+0odPc="
}
}复制
失败案例
{"msg":"参数解密失败","code":300}复制
注 : mobile为加密后的手机号,需要使用RSA进行解密。(工具类请参考“一键登录服务端工具类”)
3.App本机号码校验
Path：/oauth-api/oauth/verifyMobile/{userId}/{appId}
Method： POST
接口描述：根据输入的手机号校验是否为本机手机号
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
|
|
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId |
|
用户ID,由SDK初始化时获取 |
| appId |
|
申请的应用ID |
Body
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| token | string | 必须 | SDK获取到的一键登录token |
| sign | string | 必须 | Encrypt相对应算法生成的签名，详见附录 |
| encrypt | string | 非必须 |
可填值：RSA、SHA、SM3、MD5 可为空：默认为MD5方式 |
返回数据
成功案例
{"msg":"success","code":200,"data":"dr+ikip7NFT1Dvd3IRIkg+Cq+I+sjk0wWPXtATTf2nNmkwVnJYtXE9
XS823d8eqV0vshGsxxRofaYIbX7CfJh55ssZ191yMPczTIBlWxga2oxcakQbcxGiaJqXr
lApNGVmAJKuwGWQ8Rk5a+fg0GWdQVwYCSh4/WzBd3yYj37+0="}复制
失败案例
{"msg":"参数解密失败","code":300}复制
data解密后说明:
{"verifyMobile":1}复制
| 标识 | 类型 | 说明 |
|---|---|---|
| verifyMobile | int | 验证结果 0：一致，1：不一致，2：无法判断 |
注 : data为加密后的结果,需要使用RSA进行解密。(工具类请参考“一键登录服务端工具类”)
4.H5本机号码校验
Path：/oauth-api/oauth/verifyMobileH5/{userId}/{appId}
Method： POST
接口描述：根据输入的手机号校验是否为本机手机号
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| userId | 用户ID,由SDK初始化时获取 | |
| appId | 申请的应用I |
Body
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| token | string | 必须 | SDK获取到的一键登录token |
| userInformation | string | 必须 | 浏览器指纹 |
| sign | string | 必须 | Encrypt相对应算法生成的签名，详见附录 |
| encrypt | string | 非必填 |
可填值：RSA、SHA、SM3、MD5 可为空：默认为MD5方式 |
返回数据
成功案例
{"msg":"success","code":200,"data":"dr+ikip7NFT1Dvd3IRIkg+Cq+I+sjk0wWPXtATTf2nNm
kwVnJYtXE9XS823d8eqV0vshGsxxRofaYIbX7CfJh55ssZ191yMPczTIBlWxga2oxcakQbcxGiaJq
XrlApNGVmAJKuwGWQ8Rk5a+fg0GWdQVwYCSh4/WzBd3yYj37+0="}复制
失败案例
{"msg":"参数解密失败","code":300}复制
data解密后说明:
{"verifyMobile":1}复制
| 标识 | 类型 | 说明 |
|---|---|---|
| verifyMobile | int | 验证结果 0：一致，1：不一致，2：无法判断 |
注 : data为加密后的结果,需要使用RSA进行解密。(工具类请参考“一键登录服务端工具类”)
5.返回码
| 返回码 | 返回码描述 |
|---|---|
| 200 | Success |
| 10101 | 应用标识不能为空 |
| 10102 | 运营商类型不能为空 |
| 10103 | 浏览器加密指纹不能为空 |
| 10104 | 业务凭证信息不能为空 |
| 10105 | Token校验失败 |
| 10106 | Token已被使用 |
| 10107 | 校验码不能为空 |
| 10201 | 应用正在审核中! |
| 10202 | 应用标识不存在！ |
| 10301 | 该应用一键登录能力无资源！ |
| 10302 | 该应用一键登录能力已退订！ |
| 10303 | 该应用一键登录能力资源包用尽！ |
| 10304 | 该应用一键登录能力资源包到期！ |
| 10500 | 取号失败 |
6.附录
6.1 sign验签规则
参数拼接规则：userId + appId + token + appSecret （不包括加号）
encrypt参数为MD5时: MD5方式循环加密4次；
encrypt参数为RSA时: 使用创建应用时，填写到平台RSA公钥相对应的私钥生成签名；
encrypt参数为SHA时: SHA1生成签名；
encrypt参数为SM3时: 使用appSecret做密匙生成签名。
注：详情请查看“一键登录服务端工具类”。
