掌趣PC扫码登录SDK

1.文档说明

1.1 功能描述

此文档主要是用于在游戏PC客户端接入扫码功能。

1.2 阅读对象

接入掌趣扫码SDK的游戏UNITY客户端开发者。

3.特别说明

SDK使用引擎unity 2019.4.26版本开发。
暂时不支持在编辑器里面调试，只能编译成EXE以后使用。
暂时不支持64位编译。请使用X86编译。

2.使用说明

2.1 参数配置

开发者需要在掌趣平台获取配置文件，并把配置文件放到Assets/Resources/ 目录下。

2.2 初始化接口

2.2.1 接口说明

需要在调用登录之前调用初始化接口。

2.2.2 接口使用

OurpalmSDK.GetInstance().init();

2.3 检查是否有公告接口

2.3.1 接口说明

请务必在初始化之后调用。

2.3.2 接口定义

    /**
     * 检查是否有公告
     * gameVersion 游戏版本号
     */
    public void checkOurpalmPcNotice(string gameVersion)

2.3.3 接口使用

OurpalmSDK.GetInstance().checkOurpalmPcNotice("9.9.9");

2.3.4 接口回调

2.3.4.1 接口回调说明

返回检查是否有公告的结果，noticeSwitchData = “1”表示有公告; = “0”表示没有公告

2.3.4.2 接口回调定义

/**
*@param data  返回是否有公告
*/
private void Ourpalm_CheckNotice(string noticeSwitchData)

2.3.4.3 接口回调说明

// 注册事件
OurpalmSdkCallBack.Ourpalm_CheckNotice += Ourpalm_CheckNotice;
//取消事件
OurpalmSdkCallBack.Ourpalm_CheckNotice -= Ourpalm_CheckNotice;
// 事件实现
private void Ourpalm_CheckNotice(string noticeSwitchData){
    Debug.Log("Ourpalm_CheckNotice  noticeSwitchData = " + noticeSwitchData);
}

2.4 打开公告接口

2.3.1 接口说明

请在检查是否有公告接口返回结果之后调用。

2.3.2 接口定义

    /**
     * 打开公告页面
     * gameVersion 游戏版本号
     */
    public void OurpalmPcNotice(string gameVersion)

2.3.3 接口使用

OurpalmSDK.GetInstance().OurpalmPcNotice("9.9.9");

2.4 登录接口

2.4.1 接口说明

请务必在初始化之后调用。

2.4.2 接口使用

OurpalmSDK.GetInstance().OurpalmLogin();

2.5 登录成功事件

2.5.1 接口说明

登录成功以后被调用, 此事件被调用时，登录页面也会被自动关闭。
开发者拿到数据后，请勿直接使用。需要调用服务端验证接口验证，使用服务端数据为准。

2.5.2 接口定义

/**
*@param data  成功以后返回的用户数据.json格式
*/
private void Ourpalm_LoginSuccess(string data)

2.5.3 接口使用说明

// 注册事件
OurpalmSdkCallBack.Ourpalm_LoginSuccess += Ourpalm_LoginSuccess;
//取消事件
OurpalmSdkCallBack.Ourpalm_LoginSuccess -= Ourpalm_LoginSuccess;
// 事件实现
private void Ourpalm_LoginSuccess(string data){
    Debug.Log("Ourpalm_LoginSuccess  data = " + data);
}

2.6 登录失败事件

2.6.1 接口说明

登录失败以后被调用。
此事件被调用时，登录页面也会被自动关闭。

2.6.2 接口定义

/**
*    @param code  登录失败code，
*    @param data  错误信息。
*/
private void Ourpalm_LoginFail(int code,string data)

2.6.3 接口使用说明

// 注册事件
OurpalmSdkCallBack.Ourpalm_LoginFail += Ourpalm_LoginFail;
//取消事件
OurpalmSdkCallBack.Ourpalm_LoginFail -= Ourpalm_LoginFail;
// 事件实现
private void Ourpalm_LoginFail(int code, string data){
    Debug.Log("Ourpalm_LoginFail code = " + code + " data = " + data);
}

2.7 支付接口

2.7.1 接口说明

请务必在登录接口之后调用。

2.7.2 接口定义

    /**
    * 支付接口
    * 
    * @param propId
    *            游戏自定义的商品ID
    * @param chargeCash
    *            价格（以分为单位）
    * @param currencyType
    *            货币类型(1人民币2美元3日元4港币5英镑6新加坡币7越南盾8台币9韩元)
    * @param propName
    *            商品名称
    * @param propCount
    *            商品数量
    * @param propDes
    *            商品描述
    * @param Gameurl
    *            游戏发货地址(如游戏未传，则使用在平台配置的地址进行发货通知)
    * @param ExtendParams
    *            扩展参数
    * @param serverId
    *            服务器Id
    * @param roleId
    *            角色Id
    * @param roleName
    *            角色名称
    * @param rolelv
    *            角色等级
    * @param roleviplv
    *            角色VIP等级
    */
    public void OurpalmPCPay(string propId, string chargeCash,
        string currencyType, string propName,
        string propCount, string propDes, string Gameurl,
        string ExtendParams, string serverId,
        string roleId, string roleName, 
        string rolelv, string roleviplv)

2.7.3 接口使用

mOurpalmSDK.OurpalmPCPay("0001", "1", "1",
                "测试-商品名称111", "100", "测试-商品描述11111", "", "测试-我是扩展参数",
                "10001", "role_123", "testrole1",
                "1", "1");

2.8 支付成功事件

2.8.1 接口说明

支付成功以后被调用, 此事件被调用时，会弹出支付成功页面。
收到此回调只表示支付流程结束，游戏是否发货要以服务端充值结果为准。

2.8.2 接口定义

/**
*支付成功回调
* @param code 错误码
* @param ssid 订单号
* @param pbid 商品id
*/
private void Ourpalm_PaySuccess(string code, string ssid, string opid)

2.8.3 接口使用说明

// 注册事件
OurpalmSdkCallBack.PaymentSuccess += Ourpalm_PaySuccess;
//取消事件
OurpalmSdkCallBack.PaymentSuccess -= Ourpalm_PaySuccess;
// 事件实现
private void Ourpalm_PaySuccess(string code, string ssid, string opid)
    {
        Debug.Log("Ourpalm_PaySuccess code = " + code + " ssid = " + ssid);
        mText.text = " 支付成功 code = " + code + " ssid = " + ssid;
    }

2.9 支付失败事件

2.9.1 接口说明

支付失败以后被调用。
此事件被调用时，支付页面也会被自动关闭。

2.9.2 接口定义

/**
*支付失败回调
* @param code 错误码
* @param ssid 订单号
* @param pbid 商品id
*/
private void Ourpalm_PayFail(string code, string ssid, string opid)

2.9.3 接口使用说明

// 注册事件
OurpalmSdkCallBack.PaymentFail += Ourpalm_PayFail;
//取消事件
OurpalmSdkCallBack.PaymentFail -= Ourpalm_PayFail;
// 事件实现
private void Ourpalm_PayFail(string code, string ssid, string opid)
    {
        Debug.Log("Ourpalm_PayFail code = " + code + " ssid = " + ssid);
        mText.text = " 支付失败 code = " + code + " ssid = " + ssid;
    }