iOS国内SDK接入说明

1 接入指南

1.1 获取配置文件

接入前，需要由掌趣项目负责人完成渠道申报并在掌趣后台进行配置，从而获取到该游戏的渠道参数、掌趣配置文件。

1.2 掌趣SDK构成

掌趣 IOS SDK支持 iPhone、iPad、iPod Touch设备，要求armv7、armv7s或arm64架构，操作系统要求Mac要求Lion以上，Xcode要求7以上，iOS SDK要求8.0以上。
掌趣iOS SDK主要由以下几部分构成，如下图：

[1] Ourpalmlib掌趣封装静态库
只支持armv7、armv7s和arm64架构，固件要求iOS8.0以上
[2] Thirdilb第三方静态库.a或Framework
掌趣静态库封装调用的第三方静态库或Framework
[3] OpenSource第三方开源库
掌趣SDK所使用的第三方开源库或源文件，避免SDK与游戏产生冲突
[4] Splash掌趣SDK提供的闪屏支持
闪屏为xcode自带闪屏显示后的闪屏，最多支持3张。使用请在info.plist中设置Ourpalm_Splash字段，类型Number，数量即闪屏数量(不包括xcode自带闪屏)， 分辨率以及命名方式请参照demo。若需改变闪屏显示时间请在info.plist中设置Ourpalm_SplashInterval字段，类型string，建议设置范围2-5秒，闪屏默认间隔2秒。
若需要添加视频闪屏请在info.plist中设置Ourpalm_SplashVideo字段，类型bool，YES为显示视频闪屏。掌趣资源文件ourpalm_res.bundle中有一个默认视频logoMovie.mp4。若需替换请自行将其替换或使用打包工具，文件名不可修改、格式必须为mp4！视频闪屏的出现的时间点永远在xcode默认闪屏之后，并且支持视频闪屏+图片闪屏的模式。图片闪屏在视频闪屏结束后自动插播！

1.3 搭建开发环境

1.3.1 工程配置

Xcode->Project->Build Settings工程配置
[1] 添加库的连接参数
请在工程文件Build Settings处，找到Other Linker Flags，并添加以下内容


[2] 请将Apple LLVM 5.0 – Language – C++中C++ Standard Library项修改为以下内容


注意：
(1)Compiler Default的默认值在xcode5中为libstdc++，但在xcode6中的默认值为libc++。
(2)如果游戏需要支持C++11的新特性，C++ Standard Library需要设置为libc++,如下图，并且需要使用llvm文件中的静态库


[3] 其他编译设置

1.3.2 Framework添加及配置（请特别注意！）

请将OurpalmSDK文件夹拖到你的工程Groups&Files面板中，截图如下

添加Framework后，请注意Optional的库，如下图：

1.3.3 设置URL Schemes（请特别注意！）

需添加2个URL Schemes 如下图：
1.为游戏的bundleId
2.为jdpauth2d143b3351cbdf8bb8a12353e0e6dc37

具体方法：选中工程中的Target，选中Info标签页，找到底下的URL Types，展开，点击加号，创建URL Scheme

1.3.4 xcode必要配置（请特别注意！）

[1] 支持HTTP设置
ios9 下苹果要求 App 内访问网络必须使用 HTTPS ，现阶段不能马上改成 https。
请在 Info.plist 中添加 NSAppTransportSecurity 类型 Dictionary.在 NSAppTransportSecurity 下添加 NSAllowsArbitraryLoads 类型 Boolean,值设为 YES。如下图


[2] 白名单设置
单独接入appstore包时不能添加alipay的白名单，有可能被拒审！
（请保留weixin、weixinULAPI白名单配置）*

<key>LSApplicationQueriesSchemes</key>
<array>
<string>weixin</string>
<string>weixinULAPI</string>
</array>

[3] 相册、日历、拍照权限设置
使用Xcode8打包时，中访问相册和日历功能需要设置权限使用描述，如下图

<key>NSCalendarsUsageDescription</key>
<string>需要使用日历</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>需要使用相册</string>
<key>NSCameraUsageDescription</key>
<string>需要使用相机</string>

[4] 崩溃、卡顿监控
若游戏不使用该功能，请将OPCrashMonitor.a从工程中去除。
[5] 去除系统冗余日志输出（非必须）
使用Xcode8调试时请做以下设置，防止无用的系统日志在控制台输出，如下图


[6] entitlements设置
由于需要在keychain中记录设备唯一标识，需要在Capabilities中设置keychain sharing的权限，具体如下图：

1.3.4 dSYM符号化文件配置（请特别注意！）

[1] dSYM文件
在XCODE编译项目之后,会在app旁看见一个同名的dSYM文件。dSYM文件是iOS编译后保存16进制函数地址映射信息的文件，每次应用程序build后，都会生成对应的xxx.app, xxx.app.dSYM文件。通过此文件可以将16进制地址转换成可读的函数地址，精确定位crash位置，如下图所示：



[2] 工程配置

1.3.5 掌趣info.plist参数配置表（请特别注意！）

    <key>Ourpalm_AutoOrientation</key>
    <true/>
    <key>Ourpalm_BlockInterval</key>
    <string>10</string>
    <key>Ourpalm_Debugmodel</key>
    <true/>
    <key>Ourpalm_FSInterval</key>
    <string>0</string>
    <key>Ourpalm_FVLocation</key>
    <integer>2</integer>
    <key>Ourpalm_GameOnline</key>
    <true/>
    <key>Ourpalm_GameResVersion</key>
    <string>1.0</string>
    <key>Ourpalm_InitOrientation</key>
    <string>UIInterfaceOrientationLandscapeRight</string>
    <key>Ourpalm_Push</key>
    <true/>
    <key>Ourpalm_ShowInitLoading</key>
    <false/>
    <key>Ourpalm_Splash</key>
    <integer>3</integer>
    <key>Ourpalm_SplashInterval</key>
    <string>1.5</string>
    <key>Ourpalm_SplashVideo</key>
    <true/>
    <key>Ourpalm_DefferingSG</key>
    <string>UIRectEdgeAll</string>
    <key>Ourpalm_HI_AutoHidden</key>
    <false/>

1.4 接入准备

服务端配置：请参考 通用接入文档—> 《SDK服务端接入说明文档》

2 初始化

2.1 启动接口

功能说明
应用启动时，初始化SDK，并添加奔溃、阻塞监控
接口定义

bool ApplicationDidFinishLaunchingWithOptions(void *application,void *launchOptions);

接口示例

- (BOOL)application:(UIApplication *)application  
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions  
{  
//注意这里不可添加其他代码  
OPGameSDK::GetInstance().ApplicationDidFinishLaunchingWithOptions(application, launchOptions);  
//…  
}

2.2 初始化接口

功能说明
1、初始化第三方SDK，同时获取SDK所需要的初始化数据
2、检查版本更新，初始化内部封装了第三方的更新接口
接口定义

void Init(void* controller,OPInitParam opInfo);

注意：
1.初始化接口在不同游戏引擎添加的位置不同，具体参看代码示例
2.游戏本身的初始化最好在SDK的初始化结束并成功后开始，因为部分渠道的SDK有自动展示LOGO的功能，如果游戏的初始化先于SDK的初始化或两者并行可能会造成渠道的LOGO展示部出来或显示时间很短的BUG
3.由于SDK已集成收集奔溃日志的功能，如果游戏使用的是U3D引擎，需要将UnityAppController.mm中的部分代码进行注释，如下图:

参数说明

接口示例

//初始化回调函数
void initCallBack(bool result,constchar* jsonStr)
{    
    //返回初始化结果
}

（1）对于coco2d-x引擎：
初始化接口必须放在cocos2d::CCApplication::sharedApplication()->run();之后，且需要添加代码self.window.rootViewController = viewController;

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
{
    //。。。
  self.window.rootViewController = viewController;
  [windowmakeKeyAndVisible];
  cout<<"OPGameSDK LOG:游戏开始初始化！"<<endl;
   cocos2d::CCApplication::sharedApplication()→run();
  cout<<"OPGameSDK LOG:OurplamSDK开始初始化！"<<endl;
   OPSDK::GetInstance().init(self.viewController);
}

（2）对于unity3d引擎：
初始化接口必须放在OnUnityReady();之后。

- (void)startUnity:(UIApplication*)application
{
    //。。。。。。
    OnUnityReady();
    //掌趣SDK初始化
         cout<<"OPGameSDK LOG:OurplamSDK开始初始化！"<<endl;
         OPSDK::GetInstance().init(self.viewController);
 }
void OPSDK::init(void* rootViewController)
{
    // 初始化回调设置
    OPGameSDK::GetInstance().InitCallBack(initCallBack);
    // 登录注册回调设置
    OPGameSDK::GetInstance().RegisterLoginCallBack(loginCallBack); 
    // 登出回调设置
    OPGameSDK::GetInstance().RegisterLogoutCallBack(logoutCallBack);
    //设置购买回调
    OPGameSDK::GetInstance().SetListener(this);
    //初始化接口
    OPGameSDK::GetInstance().Init(self.viewController);
}

2.3 获取SDK可用接口信息

功能说明
获取SDK接口是否可用
接口示例

OPGameSDK::GetInstance().GetEnableInterface();

返回数据如下,JSON格式
{
“SwitchAccount” : 1,
“Logout” : 1,
“ShowPausePage” : 0,
“EnterAppCenter” : 0,
“ShowToolBar” : 1,
“HideToolBar” : 1,
“UserFeedback” : 1,
“RegisterLogin” : 1,
“EnterUserSetting” : 0,
“EnterAppBBS” : 0,
“IsLogin” : 1,
“EnterPlatform” : 1
}
1: 表示接口可用
0: 表示接口不可用

返回数据说明：
切换账号接口 可用
注销账号接口 可用
暂停页接口 不可用
游戏大厅接口 不可用
显示悬浮球接口 可用
关闭悬浮球接口 可用
客服反馈接口 可用
注册登录接口 可用
用户设置接口 不可用
进入论坛接口 不可用
登录状态接口 可用
用户中心接口 可用

2.4 获取渠道信息接口

功能说明
获取当前SDK渠道信息
接口定义

const char*  GetChannelInfo();

接口示例

OPGameSDK::GetInstance().GetChannelInfo();

返回数据如下,JSON格式
{“channelId”:”3101430031014300”,”channelName”:”appstore”,”deviceGroupId”:”0002”,”localeId”:”01”,”serviceId”:”1000053831014300000”}

说明：
serviceId 业务ID
channelId 渠道ID
deviceGroupId 机型组ID
localeId 语言ID

为了方便游戏接入，提供以下接口获取：
（1）获取业务ID
OPGameSDK::GetInstance().GetServiceId ();

（2）获取渠道ID
OPGameSDK::GetInstance().GetChannelId();

（3）获取渠道名称
OPGameSDK::GetInstance().GetChannelName();

（4）获取机型组ID
OPGameSDK::GetInstance().GetDeviceGroupId();

（5）获取语言ID
OPGameSDK::GetInstance().GetLocaleId();

2.5 设置openURL

功能说明
在调用第三方app进行支付时，设置该接口，在支付完成后回调游戏。

接口定义

bool HandleOpenURL(void* url);
void HandleOpenURL(void* url, void* application);
bool HandleOpenURL(void* application,void* url,void* sourceApplication,void* annotation);

接口示例 (以下三个方法必须都添加)

- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url
{
    if (OPGameSDK::GetInstance().HandleOpenURL(url)) {
        returnYES;
    }
    returnNO;
}
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
    if(OPGameSDK::GetInstance().HandleOpenURL(application,url,sourceApplication,annotation)) {
        returnYES;
    }
    returnNO;
}
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString*, id> *)options
{
    if(OPGameSDK::GetInstance().HandleOpenURL(app,  url,
                                              [options valueForKey:@"UIApplicationOpenURLOptionsSourceApplicationKey"],
                                              [options valueForKey:@"UIApplicationOpenURLOptionsAnnotationKey"])) {
        return YES;
    }
    return NO;
}

2.6 屏幕旋转设置

功能说明
通过从Info.plist文件中获取的Ourpalm_AutoOrientation参数来设置游戏是否支持自动旋转。但还需要在appDelegate.mm中设置以下方法
接口定义

unsigned int ApplicationSupportedInterfaceOrientationsForWindow(void *application,void *window);

接口示例

- (NSUInteger)application:(UIApplication *)application 
                supportedInterfaceOrientationsForWindow:(UIWindow *)window
{
    if (OPGameSDK::GetInstance().ApplicationSupportedInterfaceOrientationsForWindow()) {
        returnOPGameSDK::GetInstance().
            ApplicationSupportedInterfaceOrientationsForWindow(application, window);
}
    returnUIInterfaceOrientationMaskAll;
}

2.7 页面旋转接口

功能说明
用于控制界面旋转，请添加至rootViewController中
接口示例

Objective-C
- (BOOL)shouldAutorotate
{
    return OPGameSDK::GetInstance().ShouldAutoRotate();
}
Unity3D
BOOL ShouldAutorotate_DefaultImpl(id self_, SEL _cmd)
{
    return OPGameSDK::GetInstance().ShouldAutoRotate();
}

2.8 进入前台接口

功能说明
在游戏进入前台时候调用，暂停页已封装入此接口，请添加至AppDelegate.mm中，U3D游戏为AppController.mm中
接口示例

- (void)applicationWillEnterForeground:(UIApplication*)application
{
    OPGameSDK::GetInstance().ApplicationWillEnterForeground(application);
}

3 登录功能

3.1 登录流程

1.手机游戏客户端会调用掌趣sdk进行sdk初始化操作
2.掌趣sdk向掌趣用户中心服务器发起登录/注册的请求
3.掌趣用户中心服务器向掌趣sdk返回token、用户信息等等
4.掌趣sdk向返回游戏客户端登录结果和用户信息
5.游戏客户端上传用户信息到游戏服务器
6.服务器根据token向掌趣用户中心服务器获取用户信息
7.掌趣用户中心服务器向游戏服务器返回用户信息
8.游戏服务器向游戏客户端返回登录结果

3.2 登录接口

功能说明
登录掌趣用户中心。游戏客户端调用登录接口（RegisterLogin）前，需要通过设置登录回调接口（RegisterLoginCallBack）将回调函数指针传给SDK，登录成功后，掌趣SDK会通过回调函数通知游戏客户端。

接口定义

//设置登录回调接口
void RegisterLoginCallBack(void (* pf)(bool result,constchar* jsonStr));
//登录接口
void RegisterLogin(OPUserType sdkType=kNoneType);

参数说明

接口示例

//回调函数
void loginCallBack(bool result,constchar* jsonStr)
{    
    //返回登录结果
}
//设置登录回调接口
OPGameSDK::GetInstance().RegisterLoginCallBack(loginCallBack);
//登录接口
OPGameSDK::GetInstance().RegisterLogin();

其中对应的OPUserType类型
kRegister=1, //注册
kNormalLogin, //常规登陆
kPhoneLogin, //手机登陆
kEmailLogin, //邮箱登陆
kQuickLogin, //快速登陆

返回的JSON数据格式说明
登录成功时 {“userId”:”掌趣平台分配的用户唯一id，区分大小写”,
“returnJson”:{第三方SDK平台返回的数据,一般情况下游戏无需关心},
“tokenId”:”掌趣分配的tokenId”,
“currentUserType”:”当前用户类型 speedy=快登用户、common=普通用户名密码用户、phone=手机号注册用户、thirdHidden=第三方隐性用户”,
“userName”:”掌趣平台中的用户名”}

登录失败时 {“desc”:”失败描述”,
“reset”:”状态码”,”status”:”1”}

实名相关：
“status”: “1” 认证中， “2”认证成功， “-1” 认证失败
“isAdult”: “0” 未成年， “1” 成年

注意：

1. 返回失败时，SDK会弹出提示框！对于请求超时（状态码为101），不会弹出提示框，游戏可自动重新连接或自己添加提示框。
2. 用户区分大小写，相同字母和数字、大小写不同的用户ID代表的是两个不同的用户账号。因此，游戏在使用和存储掌趣用户ID时，务必要严格区分大小写，以免造成游戏内账号和角色的混乱等问题。
3. 如果游戏有自己的用户ID，必须和掌趣用户中心的用户ID一一对应，不得出现一对多或者多对一的情况。也不得根据其他条件，组合生成新的用户ID，否则将会出现账号丢失的情况。

3.3 PC二维码扫码登录

功能说明
用于支持PC端的游戏，使用手机进行扫码登录，该接口需要在账号登录成功后调用。

接口定义

void CodeScanner();

接口示例

OPGameSDK::GetInstance().CodeScanner();

3.4 设置角色信息

功能说明
当游戏角色注册（登录）成功时设置游戏角色注册（登录）信息。

注：
1、游戏角色注册成功后，调用该接口设置角色注册信息。
2、游戏角色登录成功后，调用该接口设置角色登录信息，否则无法计费。
3、此类型是用于兼容第三方SDK中，角色升级的一种类型。

接口定义

void SetGameLoginInfo(OPGameInfo opGameInfo,OPGameType opGameType);

参数说明

OPParam参数说明

接口示例

OPGameInfogameInfo;
gameInfo.mGame_RoleId = "123456";                    //游戏角色id
gameInfo.mGame_RoleName = "Jack";                    //游戏角色名称
gameInfo.mGame_ServerId = "123";                    //游戏服务器id 
gameInfo.mGame_ServerName = "test";                    //游戏服务器名称
gameInfo.mGame_RoleLevel = "1";                        //游戏角色等级
gameInfo.mGame_RoleVipLevel = "1";                    //游戏角色vip等级
//游戏角色注册成功时调用
OPGameSDK::GetInstance().SetGameLoginInfo(gameInfo,kGameRegister);
//游戏角色登录成功时调用
OPGameSDK::GetInstance().SetGameLoginInfo(gameInfo,kGameLogin);

3.5 注销接口

功能说明
注销当前登陆账号。游戏客户端调用注销接口（LogOut）前，需要通过设置注销回调接口（RegisterLogoutCallBack）将回调函数指针传给SDK，注销成功后，掌趣SDK会通过回调函数通知游戏客户端。

接口定义

void LogOut();

接口示例

//回调函数  
void logoutCallBack(bool result,constchar* jsonStr)  
{     
    //返回的JSON数据格式说明  
    调用登出接口，登出成功时  
    {"Type":"Logout"}  //如果jsonStr == NULL，默认为调用登出接口，登出成功  
    调用切换账号，登出成功时  
    {"Type":"SwitchAccount"}  
}  
//设置注销回调接口  
OPGameSDK::GetInstance().RegisterLogoutCallBack (logoutCallBack);  
//注销接口  
OPGameSDK::GetInstance().LogOut();

3.6 切换账号

功能说明
注销当前登录账号，切换成功后会调用注销回调函数通知游戏客户端。

接口定义

void SwitchAccount();

接口示例

//回调函数  
void logoutCallBack(bool result,constchar* jsonStr)  
{  
    //返回的JSON数据格式说明  
    调用登出接口，登出成功时  
    {"Type":"Logout"}  //如果jsonStr == NULL，默认为调用登出接口，登出成功  
    调用切换账号，登出成功时  
    {"Type":"SwitchAccount"}  
}  
//设置注销回调接口  
OPGameSDK::GetInstance().RegisterLoginCallBack (logoutCallBack);  
//切换账号接口  
OPGameSDK::GetInstance().SwitchAccount();

4 支付功能

4.1 支付流程

1.掌趣sdk向掌趣计费服务器发起支付请求
2.掌趣计费服务器生成订单号，并向sdk返回支付结果
3.掌趣计费服务器通知游戏服务器发货
4.游戏服务器发送虚拟物品至玩家手机游戏客户端
5.游戏服务器向计费服务器返回发货结果

4.2 支付接口

功能说明
游戏客户端通过调用计费接口，实现游戏中的道具购买。游戏客户端调用计费接口（Purchase）前,需要继承PurchaseListener，通过设置接口（SetListener）将对象指针传给SDK，计费成功后，掌趣SDK会通过OnPurchaseResult通知游戏客户端。
接口定义

void SetListener(PurchaseListener* listener);  
//计费接口  
void Purchase(OPPurchaseParam params);

参数说明

接口示例

class OPTest : public PurchaseListener  
{   //通知计费结果  
    void OnIAPResult(bool result, const char* jsonStr);  
}  
void OPTest::OPPurchase  
{  
    OPIAPParam params;  
    params.mPrice = "100";    //商品价格  
    params.mCurrencyType = "1";    //货币类型，人民币为1  
    params.mPropName = "宝石";    //商品名称，不含数字  
    params.mPropId = "4261299";    //游戏自定义商品id  
    params.mPropNum = "100";     //商品数量，只能是数字  
    params.mPropDescribe = "";    //商品描述  
    params.mDeleverUrl = "";    //发货地址(必填)  
    params.mExtendParams = "";    //自定义参数  
    params.mGameRoleLevel = "";    //游戏角色等级(可选)  
    params.mGameRoleVipLevel = "";    //游戏VIP等级(可选)  
    OPGameSDK::GetInstance().SetListener(this);  
    OPGameSDK::GetInstance().IAP(params);    //购买接口  
}

注：1、Android端和iOS端返回错误码不一致。2、Android返回参数key为小写{String ssid, String pbid}，iOS端返回json中的key为小驼峰{ “desc”:成功描述,”propId”:”道具ID”,”reset”:”120”,”ssId”:”订单号}

5 礼包码兑换功能

功能说明
兑换礼包码
接口定义

void ExchangeGameCode(const char *gamecode,const char *deleverUrl,const char *extendParams);

参数说明

接口示例

void OPSDK::OnGamecodeResult(bool result, const char* jsonStr)
{
// 返回礼包码兑换结果
}
void OPSDK:: ExchangeGameCode()
{
    const char* gamecode = “”;
    const char* deleverUrl = “http://wwww”;
    const char* extendParams = “”;
    OPGameSDK::GetInstance().ExchangeGameCode(gamecode,deleverUrl,extendParams);
}

6 客服功能

功能说明
在登录游戏后，调用此接口打开用户反馈界面
接口示例

   OPGameSDK::GetInstance().UserFeedback();

7 推送功能（使用推送必须添加）

7.1 APNS

功能说明
掌趣APNS推送所必须添加的接口，请在appdelegate.mm中添加以下方法
接口示例

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{  
    OPGameSDK::GetInstance().DidRegisterForRemoteNotificationsWithDeviceToken(application, deviceToken);
}
- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
{  
    OPGameSDK::GetInstance().DidFailToRegisterForRemoteNotificationsWithError(application, error);
}
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo
{
    OPGameSDK::GetInstance().DidReceiveRemoteNotification(application, userInfo);
}

注意事项：
使用Xcode8以上IDE出包，需要将Push Notifications的权限打开，否则无法过审appstore.

7.2 获取推送唯一标识（服务器接口推送必接）

功能说明
获取掌趣服务器推送所需的推送唯一标识，详情请参考服务器推送文档接口示例

OPGameSDK::GetInstance().GetPushIdentity();

7.3 本地推送

功能说明
此接口主要用于游戏定时通知用户相关活动，具体推送规则如下：
1.调用一次接口创建一条推送
2.所有本地推送会在下次重启游戏时清除
3.推送时间以客户端本机时间为准
4.创建相同的推送会触发相应的次数
参数说明

NSMutableDictionary *notify = [[[NSMutableDictionary alloc] init] autorelease];
// 每日 day  每周 week  每月 month
[notify setObject:@"day" forKey:@"intervalType"];
[notify setObject:@"20170703" forKey:@"date"];
[notify setObject:@"15" forKey:@"hour"];
[notify setObject:@"44" forKey:@"min"];
[notify setObject:@"我是内容" forKey:@"content"];
[notify setObject:@"我是标题" forKey:@"title"];
OPGameSDK::GetInstance().CreatNewLocalNotification(notify);

8 其他功能

8.1 ServiceCode接入流程

功能说明
获取ServiceCode用于服务端日志统计
1.将OPGameKit.framework添加至工程中
2.在调用SDK初始化接口后调用以下方法即可，详情可参见demo
接口示例

const char* gameResVersion = "1.0";  //游戏资源版本号
OPGameKit::GetInstance().GetServiceCode(gameResVersion);

8.2 悬浮球接口

功能说明
显示和关闭悬浮球。根据接口GetEnableInterface()来判断当前渠道是否支持该接口
接口示例

OPGameSDK::GetInstance().ShowToolBar(OPToolBarAtTopLeft);
OPGameSDK::GetInstance().HideToolBar();

8.3 进入用户中心接口

功能说明
进入用户中心界面。根据接口GetEnableInterface()来判断当前渠道是否支持该接口。
接口示例

OPGameSDK::GetInstance().EnterPlatform();

8.4 重新获取sessionId接口

功能说明
调用该接口重新获取sessionId，主要应用于支持长时间后台挂起后返回游戏不需要重新登录的游戏能够正常使用需要sessionId进行的各种业务。

请先设置监听接口
// 设置刷新TokenId回调
OPGameSDK::GetInstance().RefreshTokenIdCallBack(refreshTokenIdCallBack);
在需要重新获取TokenId的时候调用
OPGameSDK::GetInstance(). RefreshTokenId();
最后在回调中拿到最新的TokenId
void refreshTokenIdCallBack(bool result, const char* jsonStr)
{
    if (result) {
        cout<<"refreshSessionIdCallBack：已获取最新SessionId"<<endl;
        cout<<jsonStr<<endl;
    } else {
        cout<<"刷新TokenId失败"<<endl;
    }
}

8.5 打开带导航条的webview

功能说明
调用native的webview显示页面,带有刷新、前进、后退、关闭的功能

调用时传入URL即可
OPGameSDK::GetInstance().OpenWebviewWithNavbar(url);

8.6 游戏内手机号收集功能

8.6.1 检查当前账号是否已经绑定手机号

功能说明
判断当前玩家是否绑定过手机号
参数说明

               OPGameSDK::GetInstance().QueryPhoneCellectStatus(GetQueryPhoneCollectStatusCallBack);
void GetQueryPhoneCollectStatusCallBack(const char* returnJson)
{
     NSLog(@"GetQueryPhoneCollectStatusCallBack=%@", [NSString stringWithUTF8String:returnJson]);
}
查询返回数据：GetQueryPhoneCollectStatusCallBack == {“data”:{“phoneNum”:”1581124XXXX”,”isCollected”:”1”},”errorCode”:”01020001”,”errorDesc”:”成功”,”status”:”1”}
注意：游戏只需要判断isCollected，isCollected=1代表绑定过，isCollected=其他数值代表未绑定过

8.6.2 发送验证码

功能说明
发送验证码到指定手机
参数说明

    OPGameSDK::GetInstance().GetVerifyCode(@"15101154324", GetVerifyCodeCallBack);
void GetVerifyCodeCallBack(const char* returnJson)
{
     NSLog(@"GetVerifyCodeCallBack=%@", [NSString stringWithUTF8String:returnJson]);
}
查询返回数据：GetVerifyCodeCallBack == {“data”:{},”errorCode”:”01010025”,”errorDesc”:”发送未绑定手机验证码成功”,”status”:”1”}
注意：游戏只需要判断status，status=1代表发送成功，status=其他数值代表发送失败

8.6.3 收集手机号

功能说明
收集当前玩家的手机号
参数说明

    OPGameSDK::GetInstance().GetPhoneNumber(@"15101154324", @"123123", GetPhoneNumberCallBack);
void GetPhoneNumberCallBack(const char* returnJson)
{
     NSLog(@"GetPhoneNumberCallBack=%@", [NSString stringWithUTF8String:returnJson]);
}
查询返回数据：GetPhoneNumberCallBack == {“data”:{},”errorCode”:”01020001”,”errorDesc”:”成功”,”status”:”1”}
注意：游戏只需要判断status，status=1收集成功，status=其他数值代表收集失败

8.7 appstore促销码领取接口

功能说明
用于玩家在appstore兑换促销码后，领取相关道具时使用的接口，需要在角色登录后才可进行调用
参数说明

     OPGameSDK::GetInstance().GetPromotionCode("https://global-1000112300.gamebean.net/index.php?mod=http&act=Account.ouCallBack&ver=current");

8.8 恢复购买接口

功能说明
用于恢复购买非消耗型、订阅型商品，重新上传相关收据
参数说明

    OPGameSDK::GetInstance().RestorePayments();

8.9 UniversalLink回调接口

功能说明
用于universalLink使用时回调函数的接入，请在AppDelegate.mm中添加
参数说明

OPGameSDK::GetInstance().ContinueUserActivity(application, userActivity, restorationHandler);

8.10 数数SDK接入

接入说明
将Thirdlib文件夹下ThinkingSDK拖入工程中即可

获取distinctId请使用以下接口

OPGameSDK::GetInstance().GetDistinctId();

如果需要使用数数SDK里的打点请自行调用数数SDK中的接口
参考文档：https://docs.thinkingdata.cn/ta-manual/latest/installation/installation_menu/client_sdk/ios_sdk_installation/ios_sdk_installation.html

8.11 七鱼客服接入

接入说明
1.将Thirdlib文件夹下QYSDK目录中所有库拖入工程中

2.并且所有动态库需要设置为embed framework

3.需要在GSC平台上配置使用七鱼客服

9 附录

9.1 客户端错误码

9.2 用户中心错误码

9.3 计费中心错误码

9.4 货币类型及对应ID