开始使用

引入资源

  1. 方式一:NPM

    NPM 仓库地址:https://www.npmjs.com/package/@xmly-fem/web-jssdk

    1. 安装包

      npm 安装

       npm install @xmly-fem/web-jssdk
      

      yarn 安装

       yarn add @xmly-fem/web-jssdk
      
    2. JSSDK提供了 config 方法,用于初始化 JSSDK,注入的参数将自动应用到 JSSDK 内部所有模块,全局只调用一次即可。

       import { config } from '@xmly-fem/web-jssdk'
      
       config({
           app_key: '7721f10cb16aeb985303615f8e9f4aa5', // 必传
           sig_url: 'https://api.xxxxxxxx.com/jssdk_sig', // 必传
           device_id: 'dasffasddafs12345', // 必传
           timeout: 10*1000,
           debug: false,
       })
      
    3. JSSDK 提供了 XMLY、XMplayer 两个对象,分别用于业务 API音频播放器

       import { XMLY, XMplayer } from '@xmly-fem/web-jssdk'
      
  2. 方式二:CDN

    1. 引入 JS(查看所有可用 CDN 链接

      注意 url 中的版本号,不同版本的链接,区别是版本号,尽可能使用最新版本,这里的链接仅作为示例。

       <script src="https://s1.xmcdn.com/sr012018/web-jssdk/1.1.0/dist/xmsdk.min.js"></script>
      

      引入后可以访问到全局对象 window.xmsdk

    2. JSSDK提供了 config 方法,页面加载完成后,调用 config 方法初始化 JSSDK,注入的参数将自动应用到 JSSDK 内部所有模块,全局只调用一次即可。

       const { config } = window.xmsdk
      
       config({
           app_key: '7721f10cb16aeb985303615f8e9f4aa5', // 必传
           sig_url: 'https://api.xxxxxxxx.com/jssdk_sig', // 必传
           device_id: 'dasffasddafs12345', // 必传
           timeout: 10*1000,
           debug: false,
       })
      
    3. JSSDK 提供了 XMLY、XMplayer 两个对象,分别用于业务 API音频播放器

       const { XMLY, XMplayer } = window.xmsdk
      

初始化参数

参数名 类型 必填 默认值 描述
app_key String 喜马拉雅开放平台应用公钥,请参考准备工作的介绍
sig_url String 返回 signature 的接口 URL 地址(例:https://xxxxxxxx.com/jssdk_sig) , 此接口由开发者服务端开发
device_id String 设备唯一标识,详细说明
timeout Number 10 * 1000 请求超时时间(单位:毫秒,默认 10S)
debug Boolean false 是否开启 debug,开启后会在 console 控制台打印调试信息

设备唯一标识

  1. 必须保持唯一性,比如 Android 系统可以传 imei,也可以传设备 MAC 地址;

  2. 如果公司有用户隐私政策考虑可以用 MD5(真实设备号)取代,但禁止伪造,否则会被检测出来并封号;

  3. 或者,建议在用户第一次访问页面时随机生成 UUID 作为设备 ID,并且存为永久 cookie 或 localStorage,避免每次都重新生成设备 ID 生成说明

© www.ximalaya.com lnc.ALL Rights Reserved 修订时间: 2019-08-19 10:40:44

results matching ""

    No results matching ""