<br/>
## **1. 開發包說明**
```ObjectiveC
YXMSDK.framework 基礎包
YXMBundle.bundle 資源包（以前接過需要刪除）
Bugly.framework 統計包（以前接過需要刪除）
VerifyCode.framework 滑動驗證包
NTESVerifyCodeResources.bundle 滑動驗證資源
```
<br/>
## **2. 開發環境配置**
**2.1 添加依賴包**
```ObjectiveC
VerifyCode.framework
YXMSDK.framework
YXMBundle.bundle
Bugly.framework
libz.tbd
libsqlite3.tbd
StoreKit.framework
AVFoundation.framework
iAd.framework
AdSupport.framework
CoreMotion.framework
Security.framework
WebKit.framework
JavaScriptCore.framework
SystemConfiguration.framework
CoreTelephony.framework
libsqlite3.tbd
libz.tbd
```
<br/>
**2.2 工程配置**
<br/>
* yxmsdk 需要在frameWork選擇 embed&sign
<br/>
* yxmsdk 要加入在 embed frameWork
<br/>
* sdk初始化參數配置，具體值根據我司提供參數
<br/>
* Deployment Target 設置，最低版本8.0
<br/>
* Device Orientation 設置，sdk橫豎屏都支持，根據游戲選擇對應支持的方向
<br/>
* info.plist 中添加，以允許http 訪問
<br/>
* info.plist 中添加白名單
<br/>
* Other Linker Flags 添加\-ObjC
<br/>
* Enable Bitcode設置為NO
<br/>
* URL Types設置，必須與bundleID一致
<br/>
<br/>
**2.3 支付寶支付回調配置**
```ObjectiveC
以下方法在APPDelegate中添加導入頭文件 #import <YXMSDK/YXM_SDK.h>
- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url
{
[YXM_SDK yxm_showOpenURLWithURL:url ResultMessage:^(NSInteger statusCode) {
// 根據statusCode(0:成功；1:取消；2:失敗)，寫游戲業務邏輯
}];
return YES;
}
// iOS9 以前
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
[YXM_SDK yxm_showOpenURLWithURL:url ResultMessage:^(NSInteger statusCode) {
// 根據statusCode(0:成功；1:取消；2:失敗)，寫游戲業務邏輯
}];
return YES;
}
// iOS9 以后
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url
options:(NSDictionary *)options
{
[YXM_SDK yxm_showOpenURLWithURL:url ResultMessage:^(NSInteger statusCode) {
// 根據statusCode(0:成功；1:取消；2:失敗)，寫游戲業務邏輯
}]；
return YES;
}
```
<br/>
#### **備注：SDK只支持真機上運行**
<br/><br/>
## **3 接口說明**
導入頭文件 #import <YXMSDK/YXM_SDK.h>
<br/>
**3.1 初始化（必接）**
```ObjectiveC
說明：在- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions中調用
調用:
[YXM_SDK yxm_start];
```
<br/>
**3.2 初始化登出回調（必接）**
```ObjectiveC
說明：和初始化接口同時調用
[YXM_SDK yxm_logoutFinish:^{
// 寫入游戲登出邏輯…
}]；
```
<br/>
**3.3 登錄（必接）**
```ObjectiveC
[YXM_SDK yxm_loginSuccess:^(NSString*openId) {
// 成功回調
} loginFail:^(NSError *error) {
// 失敗回調
}];
```
<br/>
**3.4 登出（必接）**
```ObjectiveC
[YXM_SDK yxm_logout]；
```
<br/>
**3.5 充值（必接）**
說明：購買游戲道具時調用，這個block回調是內支付回調，支付寶回調參考2.3
| 參數 | 類型 | 名稱 | 必傳 | 備注 |
| --- | --- | --- | --- | --- |
| price | number | 價格 | 是 |
| description | string | 產品名稱 | 是 |
| notifyUrl | string | 支付回調地址 | 是 |
| extend | string | 透傳字段 | 是 |
| productId | string | 產品ID | 是 | 企業版：傳@"" |
| roleId | string | 角色ID | 是 |
| roleName | string | 角色名稱 | 是 |
| roleServerName | string | 區服名稱 | 是 |
| roleServerId | string | 區服Id | 是 |
| success | | | | 內購成功回調 |
| fail | | | | 內購失敗回調 |
調用：
```ObjectiveC
[YXM_SDK yxm_recharge:@10
description:@"一箱元寶"
codeNo:@"CodeNo200008"
url:@"http://xxxxxxxxxx/mockjsdata/11/sdk/notify"
ext:@"ext"
product:@"xxxxxxxxxx"
roleId:@"ziwei"
roleName:@"天"
roleServerName:@"22222"
roleServerId:@“123”
success:^ {
// 支付成功
} fail:^(NSError *error) {
// 支付失敗
}];
```
<br/>
**3.6 同步角色（必接）**
說明：下面三種情況下調用：1，進入游戲 2，角色等級變更 3，修改游戲名片
| 參數 | 類型 | 名稱 | 必傳 | 備注 |
| --- | --- | --- | --- | --- |
| roleName | string | 角色名稱 | 是 |
| roleServer | string | 區服名稱 | 是 |
| roleServerId | string | 區服Id | 是 |
| roleGrade | string | 角色等級 | 是 |
| roleCamp | string | 角色陣營 | | 沒有的話，傳@"" |
| roleId | string | 角色Id | 是 |
調用：
```ObjcetiveC
[YXM_SDK yxm_syncRole:@"后羿"
roleServer:@"王者榮耀"
roleServerId:@"123"
roleGrade:@"23"
roleCamp:@"123"
roleId:@"111"];
```
<br/>
**3.7 閃屏（必接）**
```ObjectiveC
說明：顯示閃屏，2秒后自動消失
調用:
[YXM_SDK yxm_splash];
```
<br/><br/>
_ _ _
至此，你已經能使用游戲貓SDK的API內容了。如果想更詳細了解每個API的用法，請閱讀**SDK Demo**。
<br/><br/>
