API 调用说明

示例

import { XMLY } from '@xmly-fem/web-jssdk'

// 创建实例
const xmly = new XMLY()

// 获取分类列表
xmly.getCategories().then(res => {
    if(res.code === 0) {
        // 成功逻辑（仅成功时 code 为 0）
        console.log(res)
    }
    // code 可能的值有：0、-1、-2、-3、-4
}).catch(error => {
    // 为了更易用，SDK内部对请求的错误进行了捕获、分类，然后走的是 resolve => 所以，开发者调用 API 时基本上不需要 catch 
    console.log(error)
}).finally(() => {
    // 其它
})

换一换 async、await 写得简洁些

import { XMLY } from '@xmly-fem/web-jssdk'

// 创建实例
const xmly = new XMLY()

async func() {
    const res = await xmly.getCategories()

    if(res.code === 0) {
        // 成功逻辑
    }
}

简介

1. 喜马拉雅业务相关 API 均挂载为实例方法；

2. 调用 JSSDK 的业务 API，仅传入业务参数即可， 平台文档中的公共参数不必传入，JSSDK 内部统一做了处理；

3. 详细的业务参数、返回值介绍请查看 喜马拉雅开放平台 - 开发者文档 - API 文档 ，以平台的 API 文档为准；

创建实例

import { XMLY } from '@xmly-fem/web-jssdk'

// 创建实例
const xmly = new XMLY()

或

const XMLY = window.xmsdk.XMLY

// 创建实例
const xmly = new XMLY()

业务 API 的回调

1. 业务 API 方法返回的是标准 Promise 对象，具有 then、catch、finally 方法；

2. 结果为统一格式：

    {
      code: 0, // 状态，0、-1、-2、-3、-4 等
      message: 'success', // 消息
      data: {} // 数据
    }
   

3. code 对应值含义：

    0       success
    -1      failed
    -2      SDK 尚未初始化，缺少必须的 app_key、sig_url 参数
    -3      获取签名（signature）、访问令牌（access_token）失败
    -4      请求超时或未知的请求错误
   

4. 请求成功，并返回正确结果时，code 值为 0；

5. SDK 内部对请求失败、错误等做了捕获、分类，所以基本不需要 catch 捕获错误，执行 then 回调时注意对 code 值区分即可；