Skip to content

7.3 网易云音乐接入

1. 背景

让 JoyInside 设备能够接入网易云歌曲的播控流程,从而正常播放网易云歌曲的相关内容。

:费用和合同请联系各自销售同学,并同步 JoyInside 产品运营(赵影雪)。

:明确费用 + 签署合同 + 完成小程序 / app 开发,才能授权接入。

2. 关键平台

平台在对接里负责什么
运营平台做「设备管理」「创建应用」的地方。给设备开通网易云权限、配置网易云技能在这里做。
负责人:客户 / 方案商 / 厂商

3. 流程步骤

3.1 创建应用

客户侧在运营平台完成应用创建。

3.2 应用授权

联系 JoyInside 产品运营(赵影雪) 给目标应用进行授权配置。

3.3 设备授权

完成上面的运营授权后,进入运营平台给设备授权。设备分两种情况:存量设备增量设备

3.3.1 存量设备

在运营平台对「存量设备」(已经存在的设备)更新网易云权限。 存量设备支持批量更新网易云权限,支持维度有:

  • appId
  • 设备类型
  • 创建时间范围 存量设备

批量开通规则:

  • 网易云资源需满足:企业已授权 + 应用已开启权限,否则无法开通,确认授权状态请联系 JoyInside 工作人员
  • 已经开通的设备不会被影响,本操作仅为增量增加

3.3.2 增量设备

增量设备(新注册的设备)在注册时,直接传入网易云权限标识,省去后续手动授权。

对应接口文档链接:4.2 设备注册与绑定存量设备请求示例

bash
curl -X POST "https://api.joyinside.com/device/register" \
  -H "Authorization: Bearer ${accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "vendorId": "xxx",
    "appId": "xxx",
    "type": "PHYSICAL_ROBOT",
    "name": "xxx",
    "deviceId": "xxx",
    "resourceAuthedList": ["WANG_YI_CLOUD"]
  }'

3.4 网易云技能添加

在运营平台配置网易云技能即可。

注意:网易云技能与歌曲点播技能互斥,如已存在歌曲点播,需要先将歌曲点播技能反勾选。

存量设备

3.5 第三方小程序接入(重要!必看!)

  • 如果第三方直接使用 JoyInside 的 AI 星球小程序,则不需要下面的操作和对接流程。
  • 如果第三方是自己的小程序或 APP,需要对接网易云授权相关流程,需要做小程序 / APP 开发(必做)。
  • 涉及到域名审核,请联系 JoyInside 产品运营(赵影雪),来配置该企业外部 H5 回跳域名。

3.5.1 配置域名授权以及认证文件

第三方的微信开发平台,添加如下五个可信域名

dl.reg.163.com
dl2.reg.163.com
music.163.com
ye.dun.163yun.com
tachat-h5.jd.com

第三方需要下载业务域名的域名认证文件,发给 JoyInside 产品运营(赵影雪)协助处理

业务域名的校验文件下载路径: 312132123

3.5.2 准备相关小程序 UI 设计稿资料

网易云账号登录设计规范:https://developer.music.163.com/st/developer/document?docId=abd9c5a3bd5c489fbee31b54b2b0905d

第三方需要提供基于设计规范设计 UI,完成后打包邮件发给 JoyInside 产品运营(赵影雪,邮箱 zhaoyingxue11@jd.com),协助审核 UI。

:审核包括完整网易云相关 UI 视觉。

3.5.3 对接网易云账号绑定相关文档(技术必看!!!)

API 文档7.3.1 网易云账号绑定API(小程序)

对接流程图

关键接口速查

步骤接口用途
获取登录配置POST /soulmate/wyy/getWyyH5LoginConfig获取 clientId / oauthState / clientType / redirectUrl,用于拼接网易云 OAuth H5 地址
轮询绑定结果POST /soulmate/wyy/getWyyH5LoginResult在 web-view 开启期间轮询绑定状态
查看账号信息POST /soulmate/wyy/getWyyAccountUser获取昵称、头像、VIP 信息等
获取已绑定设备POST /soulmate/wyy/getWyyAccountBotList查询用户账号已绑定的设备列表
设备赋权POST /soulmate/wyy/bindBotWyyAccount将网易云账号绑定到用户名下的设备
解绑设备/unbindBotWyyAccount单设备解绑
解绑账号/unbindWyyAccount整个账号解绑

接入注意事项

  1. 建议客户服务端调用相关接口,避免暴露鉴权信息。
  2. data.state(即 oauthState)需在客户端保存,作为轮询结果的关联凭证。
  3. redirectUrl 已编码,勿重复编码
  4. web-view 开启期间需要持续轮询绑定结果,直到收到 SUCCESS + code=ok + data=true
  5. 用户完成网易云 OAuth 授权后,网易云 H5 会跳转到 redirectUrl,原样携带 oauthState;JoyInside 服务端据此关联 uid 完成绑定。

3.5.4 授权后、正式上线前,完整流程视频审核(必须)

第三方需要开发并授权后,以消费者视角体验完整流程,录屏,邮件发给 JoyInside 产品运营(赵影雪,邮箱 zhaoyingxue11@jd.com,协助上线前最终审核。

:录制完整流程视频,需要体现网易云音乐提供的口播,可先自查。


如有疑问,随时联系 JoyInside 研发(李明明、李刚)。