2. iOS 接入指南 - xiaoeteam/XiaoeAppSDK-iOS GitHub Wiki

一、前置条件

1、注册使用小鹅店铺,取得店铺 app_id 2、购买小鹅店铺 SDK 接入服务,取得 client_id

SDK相关参数名词解释

参数名 描述 备注
app_id 店铺id 小鹅店铺的店铺id,在管理台获取
client_id sdk客户端ID(对应Client ID) 开通sdk服务后在管理台获取
secret_key 店铺配置安全密钥 开通sdk服务后在管理台获取

SDK-URL链接配置规则说明

参数名 规则说明 备注
店铺首页 https://{{app_id}}.h5.xiaoeknow.com 动态参数 app_id:小鹅店铺id
其他页面 通过小鹅店铺管理台以下路径:“课程管理-图文(课程类型,以图文为例)-点击某个具体的课程分享按钮-点击复制按钮”得到链接:
https://wxbe1b550e2f0d61db.h5.xiaoe-tech.com/v1/course/text/i_5e7f809dd6317_qSMuUoAi?type=2
SDK展示链接需要替换链接域名部分为{{app_id}}.h5.xiaoekonow ,例如,您的appid参数为"apprnDA0ZDw4581",那么适配SDK展示的链接如下:
https://apprnDA0ZDw4581.h5.xiaoeknow.com/v1/course/text/i_5e7f809dd6317_qSMuUoAi?type=2
动态参数 "apprnDA0ZDw4581":需动态替换为您的小鹅店铺id

1. 接入要求

  • iOS 8.0 或更高
  • Xcode 9.0 或更高版本(建议使用最新版本)

2. 接入流程

2.1 引入 framework

推荐使用 CocoaPods 导入 framework。如有特殊需求,也可以手动导入。

2.1.1 CococaPods 导入

在你的 Podfile 文件中加入一行:pod 'XEShopSDK','x.x.x'

运行 pod install

2.1.2 手动导入

XEShopSDK.framework、XEShopSDK.bundle 加入到工程 将对应的 framework 添加到 Embedded Binaries 中

⚠️注意:需要在 Build Settings 的 Other Linker flags 加上 -ObjC

2.2 配置 Info.plist 中的权限

<key>NSCameraUsageDescription</key>
<string>请允许访问您的相机</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>请允许保存图片到相册</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>请允许访问您的相册</string>
<key>NSMicrophoneUsageDescription</key>
<string>请允许访问您的麦克风</string>
<key>UIRequiredDeviceCapabilities</key>

2.3 配置 Info.plist 中的iOS9后的http网络访问权限

<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>

2.4 配置 app scheme(微信支付完成后跳转回App)

然后通过 XEConfig 将 scheme 传递给 SDK。

⚠️只有配置了 Scheme, 并正确调用 SDK 的对应方法,微信支付完成后才能正确跳转回到你的 app 中。

⚠️ **GitHub.com Fallback** ⚠️