主题
7.3.1 网易云账号绑定API(小程序)
1. API 地址
| 环境 | 域名 |
|---|---|
| 测试 | https://uat-api.joyinside.com |
| 生产 | https://api.joyinside.com |
2. 鉴权方式(与设备注册时鉴权一致)
详见:4.1 Token 鉴权
3. 登录设计视觉规范
详见:https://developer.music.163.com/st/developer/document?docId=abd9c5a3bd5c489fbee31b54b2b0905d
4. 接口文档
4.1 获取网易云音乐 H5 登录配置
- URL:
/soulmate/wyy/getWyyH5LoginConfig - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| uid | String | 用户 ID(小程序用户 id) |
| h5Token | String | JoyInside-accessToken(用于回调验签) |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | WyyH5LoginConfigDto | 登录配置数据 |
data:WyyH5LoginConfigDto
| 名称 | 数据类型 | 备注 |
|---|---|---|
| clientId | String | 网易云应用 Id(非 JoyInside appId) |
| state | String | 自定义随机字符串,oauth 回跳时会原样带回 |
| clientType | String | 接入方端类型,通常为 web |
| redirectUrl | String | 服务端已做 urlEncode,无需再 encode |
跳转网易云 H5 登录页面
https://music.163.com/st/platform/oauth/authorize?clientId=xxx&state=xxxx&clientType=xxx&redirectUrl=xxx4.2 获取网易云音乐 H5 登录结果(小程序开启 webview 后轮询此接口)
- URL:
/soulmate/wyy/getWyyH5LoginResult - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| state | String | 登录配置接口获取到的 state |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | String | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | Boolean | 是否已完成绑定,true 表示已绑定 |
4.3 获取网易云音乐账号用户信息
- URL:
/soulmate/wyy/getWyyAccountUser - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| uid | String | 用户 ID(小程序用户 id) |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | WyyAccountUserDto | 网易云账户用户信息 |
data:WyyAccountUserDto
| 名称 | 数据类型 | 备注 |
|---|---|---|
| id | String | 用户 ID |
| nickname | String | 用户昵称 |
| avatarUrl | String | 头像 URL |
| gender | Integer | 性别,1 男,2 女 |
| signature | String | 个人签名 |
| vipDetail | List<VipDetail> | VIP 详情列表 |
| fullVipDetail | List<FullVipDetail> | 完整 VIP 详情列表 |
| redVipLevel | Integer | 红 VIP 等级 |
vipDetail 元素:VipDetail
| 名称 | 数据类型 | 备注 |
|---|---|---|
| type | Integer | VIP 类型 |
| expireTime | Long | 过期时间戳 |
fullVipDetail 元素:FullVipDetail
| 名称 | 数据类型 | 备注 |
|---|---|---|
| type | Integer | VIP 类型 |
| expireTime | Long | 过期时间戳 |
4.4 解绑网易云音乐账号
- URL:
/soulmate/wyy/unbindWyyAccount - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| uid | String | 用户 ID(小程序用户 id) |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | Boolean | 是否解绑成功 |
4.5 获取网易云音乐账号绑定的设备列表
- URL:
/soulmate/wyy/getWyyAccountBotList - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| uid | String | 用户 ID(小程序用户 id) |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | List<ResourceAccountBotDto> | 账号绑定的设备列表 |
data 元素:ResourceAccountBotDto
| 名称 | 数据类型 | 备注 |
|---|---|---|
| id | Long | 主键 ID |
| createPin | String | 创建人 |
| createTime | Date | 创建时间 |
| modifyPin | String | 更新人 |
| modifyTime | Date | 更新时间 |
| yn | Integer | 删除标识 |
| bindId | String | 业务 ID |
| accountId | String | 账号 ID |
| botId | String | 设备 ID |
4.6 网易云音乐账号绑定设备
- URL:
/soulmate/wyy/bindBotWyyAccount - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| uid | String | 用户 ID(小程序用户 id) |
| botIdList | List<String> | 需要绑定的设备 ID 列表 |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | Boolean | 是否绑定成功 |
4.7 为网易云音乐账号解绑设备
- URL:
/soulmate/wyy/unbindBotWyyAccount - 请求方式:POST
请求参数
| 名称 | 数据类型 | 备注 |
|---|---|---|
| requestId | String | 请求 ID |
| vendorId | String | 企业 ID |
| uid | String | 用户 ID(小程序用户 id) |
| botIdList | List<String> | 需要解绑的设备 ID 列表 |
返回
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述 |
| data | Boolean | 是否解绑成功 |
附 1:公共返回对象
| 名称 | 数据类型 | 备注 |
|---|---|---|
| traceId | String | 链路追踪 ID |
| state | State | 返回状态,枚举值:SUCCESS、FAILURE、ERROR |
| code | String | 返回码 |
| result | String | 返回描述信息 |
| data | <T> | 业务返回数据 |
附 2:响应结果 code 枚举
| code | 说明 |
|---|---|
| ok | 正确状态码 |
| 500 | 参数 | 服务端逻辑异常 |
| 1001 | 未绑定网易云音乐账号 |
| 1002 | 绑定的网易云音乐账号已过期 |
| 其它 | 未知错误 |