# yf-sdk-doc

**Repository Path**: yfsdk/yf-sdk-doc

## Basic Information

- **Project Name**: yf-sdk-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-06-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#一、概述
###1.1 关于YfSDK
  YfSDK是一发科技有限公司推出的一款为手游开发商（CP）提供免费的、快速的接入第三方SDK一站式解决方案。  
  YfSDK目前支持Anroid客户端。    
###1.2 我们的优势
  
###1.3 接入流程
  CP只要按照以下几个简单步骤即可快速使用YfSDK接入多达几十个渠道。  
  
  * 在YfSDK后台注册账号及应用，填写应用基本信息，选择需要接入的渠道并填写渠道相关信息
  * 下载并引入YfSDK Android客户端库（一个很小的jar文件）  
  * 根据YfSDK客户端接入文档，实现初始化、登录、切换账号、支付、退出、提交游戏数据等接口，完成游戏母包  
  * 根据YfSDK服务端接入文档，实现登录验证、支付通知接口
  * 下载打包工具，一键打包出需要接入的渠道
  * 测试并提交给渠道    

#二、客户端接入

客户端调YfSDK的方法，如  
登录：  
YfSdk.getInstance().login()  
登出：  
YfSdk.getInstance().logout()  

###2.0 YfSDK配置 

* yfsdk.properties  
  YfSDK主配置文件，需要放在assets目录下
  <pre>
  \#是否debug版本，没有配置则默认为false
   **debug=false**  
  \#是否横屏，没有配置则默认为false，
   **landscape=true**  
  \#应用类型：native，unity，cocos，默认为native 
   **AppType＝native**  
  \#YfSDK给应用分配的AppId、AppKey
   **AppId=123456**
   **AppKey=888888**  
   \#是否由YfSDK验证用户登录
   **validate_login=true**
  </pre>  
* channel.properties  
  渠道配置文件，在YfSDK后台填写好渠道相关信息后，YfSDK后台自动生成，随打包工具一起下载  

###2.1 初始化接口（必接） 

* Application从YfSdkApplication派生
<pre>
public class MyApplication extends YfSdkApplication {
</pre>
* 在主Activity的onCreate方法中对YfSDK进行初始化。  
<pre>
public void init(Activity activity, final YfSdkCallback cb);

YfSdkCallback详见API说明文档
</pre>  
###2.2 闪屏 
待完善
###2.3 登录接口（必接） 
<pre>
public void login(Activity activity);
</pre>
根据验证方式的不同，登录流程有2种：  
1.YfSDK Server发起验证  
登录流程如下：  
<img src="login1.png" width = "100%" />  

在yfsdk.properties中如下配置，则使用这用验证方式  
**validate_login=true**
这种方式

2.Game Server发起验证  
登录流程如下：  
<img src="login2.png" width = "100%" />  

CP可以根据需要采用其中的一种验证方式  

###2.4 支付接口
  
支付时填写Order各项信息，然后调用purchase接口：  
<pre>
public void purchase(final Activity activity, final Order order); 
</pre>

支付处理流程如下：
<img src="pay.png" width = "100%" />

#####2.4.1 订单ID
调用purchase时，如果没有传订单ID，YfSDK会调用YfSDK服务器接口生成订单ID。  
如果游戏服务器没配置了生成订单ID接口，那么YfSDK服务器会调用该接口来生成订单ID；如果没有配置，则YfSDK服务器会自己生成订单ID

#####2.4.2 支付通知
渠道支付成功后，渠道服务器会通知YfSDK服务器，YfSDK服务器再通知游戏服务器。游戏服务器收到支付成功的通知后，给用户发放产品，完成整个支付流程。

###2.5 退出相关接口
<pre>
YfSdk.getInstance().logout(Activity activity);
</pre>

退出的流程：  
1.用户点击游戏中的退出或系统的返回按钮  
2.游戏客户端调用YfSDK的logout方法
###2.6 用户信息扩展接口
###2.7 其他接口

#三、服务端接入

#四、注意事项
###4.1 关于包名
###4.1 关于包名