小雅OS开放平台文档

小雅OS开放平台文档

  • 快速入门
  • 客户端接入
  • 服务端接入

›iOS SDK

概述

  • 客户端接入

API 接入

  • WebSocket接口协议定义
  • Http接口协议定义
  • 调用样例
  • API 列表
  • 实体列表
  • 错误码

设备端

    Android SDK

    • 配置工程
    • 初始化
    • 功能
    • 回调
    • Demo 使用
    • 更新日志

    iOS SDK

    • 配置工程
    • 初始化
    • 功能
    • 回调
    • 更新日志

    C++ SDK

    • SDK获取方法
    • 环境要求
    • 目录结构
    • SDK架构
    • 调用示例
    • 接口文档

手机伴侣

    Android SDK

    • 接入准备
    • 账号模块
    • 内容模块
    • 反向控制
    • 设备管理模块
    • 技能模块
    • 蓝牙模块
    • 更新日志

    iOS SDK

    • 接入准备
    • 账号模块
    • 内容模块
    • 反向控制
    • 设备管理模块
    • 技能模块

内容页

    Android

    • 更新日志
    • 初始化

    iOS

    • 更新日志
    • 初始化

初始化

从开放平台官网获取到以下信息:

  • productID 产品id
  • productSecret 产品id对应的secret
  • platformID 平台id

SDK初始化代码参考:

// 设置开放平台信息
[self.ossdk setProductID:@"N_PROD1_7"
productSecret:@"134ad87f5f6346b7a2ff7899378adb59"
platformID:@"os.ptf.xmly.sdkdemo"];

NSString *prefixPath = [NSString stringWithFormat:@"%@%@",[[NSBundle mainBundle]resourcePath],@"/"];

// 语音识别配置文件
NSString *configPath = [NSString stringWithFormat:@"%@%@", prefixPath, @"xiaoya_open_platform_config.ini"];
[self.ossdk setPlatformConfig:configPath];

// 初识化SDK
BOOL ret = [self.ossdk initSDK];
if (!ret) {
dispatch_async(dispatch_get_main_queue(), ^{
[self.view makeToast:@"SDK初始化失败"];
});
return ;
}

登录

喜马拉雅授权

SDK 通过 - (void)setAuthCode:(NSString*)authCode; 方法来表明用户身份,该code的具体获取方式,需按照具体case进行对接。目前demo中通过 手机伴侣SDK 到 喜马拉雅 APP 进行授权获取code(具体方式参考 demo)。

credential登录

/**
* 通过用户凭证获取访问令牌,使用小雅OS账号体系用户可以通过平台对接,生成凭证,再使用该函数通过凭证获取访问令牌
* @param credential 凭证
*/
- (BOOL)fetchAccessTokenByCredential:(NSString *)credential;

登录成功后可通过 -(NSString *)getAccessToken;方法获取token。

集成内容页

初始化SDK

添加XYServiceSDK.framework,APP启动时初始化:

/**
* @brief 小雅OS手机助手 SDK初始化
@param platformId 用户中心鉴权 平台id
@param productId 用户中心鉴权 product id
@param productSecret product secret
@param sn 设备sn
*/
- (void)registertForMobileAssitantPlatformId:(nonnull NSString *)platformId
productId:(nonnull NSString*)productId
productSecret:(nonnull NSString*)productSecret
deviceSn:(nonnull NSString*)sn;

为SDK设置用户token

当设备完成登陆后,获取accessToken,并为XYServiceSDK设置,即可正常使用XYServiceSDK中相关接口。

/**
设置用户token

@param token 用户token
*/
+ (void)bindAccessToken:(NSString *_Nonnull)token;

集成内容页UI

若直接使用内容页接口,参考api文档进行使用;若集成UI页面,参照demo先添加framework及相关文件,调用页面初始化方法即可获取首页viewController:

/**
返回内容运营首页控制器

@return 控制器vc
*/
- (XYFlutterViewController *)homePage;
← 配置工程功能 →
  • 登录
    • 喜马拉雅授权
    • credential登录
  • 集成内容页
    • 初始化SDK
    • 为SDK设置用户token
    • 集成内容页UI
北京小雅星空科技有限公司 京ICP备19010603号