小游戏 JSSDK接入文档

1 接入指南

1.1 获取配置文件

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

1.2 添加掌趣SDK

掌趣sdk，如下图：

引入sdk

const opgamesdk = require('./OurpalmSDK/opgamesdk.js')
const ourpalmcfg = require('./OurpalmSDK/ourpalm.commonjs.js')

掌趣SDK主要由以下几部分构成
[1] opgamesdk.js 掌趣封装JS库
[2] ourpalm.commonjs.js 掌趣后台获取的掌趣配置文件

2 初始化

2.1 初始化接口

功能说明
初始化第三方SDK，同时获取SDK所需要的初始化数据

接口定义

void Ourpalm_Init(initInfo);

参数说明

接口示例

//初始化回调函数
    Ourpalm_GameEntryCallback(methodName, param) {
        if (methodName === "Callback_Ourpalm_Init") {
            //初始化回调
        }
    }

    Ourpalm_Init() {
        opgamesdk.SetGameEngineMessageListener(this.Ourpalm_GameEntryCallback);
        const initInfo = { 
            gameVer: "1.0", 
            gameResVer: "1.0.0", 
            cfg: ourpalmcfg,
            debugModel: true,
        };
        const channelType = "wxxyx"//必填
        opgamesdk.Ourpalm_Init(initInfo, channelType);
    }

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 Ourpalm_Login();

接口示例

Ourpalm_GameEntryCallback(methodName, param)
{
    if (methodName === "Callback_Ourpalm_Login") {
        //登录回调
    }
}
//登录接口
opgamesdk.Ourpalm_Login();

返回的JSON数据格式说明
登录成功时

{
    "userId":"掌趣平台分配的用户唯一id，区分大小写",
    "tokenId":"掌趣分配的tokenId",
}

登录失败时

{
    "desc":"失败描述",
    "reset":"状态码","status":"1"
}

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

3.3 设置角色信息

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

注：
1、游戏角色注册成功后，调用该接口设置角色注册信息。
2、游戏角色登录成功后，调用该接口设置角色登录信息，否则无法计费。

接口定义

Ourpalm_SetGameInfo(type,gameInfo);

接口定义

接口示例

        const gameInfo = {
            serverId: "101",
            serverName: "觉醒之力14服",
            roleId: "12345",
            roleName: "天策丶心有猛虎",
            roleLv: "5",
            roleVipLv: "1",
        }
        //角色注册
        opgamesdk.Ourpalm_SetGameInfo(1, gameInfo);
        //角色登录
        opgamesdk.Ourpalm_SetGameInfo(2, gameInfo);

4 支付功能

4.1 支付流程

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

4.2 支付接口

功能说明
游戏客户端通过调用计费接口，实现游戏中的道具购买。

接口定义

Ourpalm_Pay(propId, chargeCash, currencyType, propName, propCount, propDes, Gameurl, jsonExtendParams);

参数说明

接口示例

Ourpalm_GameEntryCallback(methodName,param)
{
    if (methodName === "Callback_Ourpalm_Pay") {
        //支付回调
    }
}
void OPSDK::pay()
{
        let propId = "Cash_1"
        let chargeCash = "100"
        let propName = "1元商品"
        let currencyType = "1";
        let propCount = "1";
        let propDes = "";
        let Gameurl = "https://pay-test.0708.com/billingcenter2.0/success.do"
        let extendParams = {};
        extendParams.Params = "游戏自定义参数";//游戏自定义参数，选填，透传参数
        extendParams.serverID = "101";//游戏服ID，必填
        extendParams.roleID = "12345";//角色ID，必填
        extendParams.rolelv = "5";//角色等级
        extendParams.roleviplv = "1";//角色VIP等级
        extendParams.roleName = "天策丶心有猛虎";//角色名称
        extendParams.gameServerName = "觉醒之力14服";//游戏服名称
        let purchaseInfo = {};
        purchaseInfo.package_id = "1001";//礼包ID
        extendParams.purchaseInfo = purchaseInfo;//选填
        let jsonExtendParams = JSON.stringify(extendParams)
        opgamesdk.Ourpalm_Pay(propId, chargeCash, currencyType, propName, propCount, propDes, Gameurl, jsonExtendParams);
}

数据示例：

{
    "channelOrderId": "2000000399537533",//第三方订单号
    "code": "200",    //购买成功
    "desc": "",
    "pdid": "buy1",    //商品id
    "ssId": "",
    "success": "1"
}

5 客服接口

opgamesdk.Ourpalm_Channel_Spreads("OpenCustomerServicePage");

6 统计和打点日志

6.1 游戏打点日志接口

此接口用于发送游戏自定义日志,以及广告统计打点日志

函数原型

Ourpalm_SendGameInfoLog(logID, logKey, json);

函数原型

注意事项

- 这些参数值和结构，由平台定义，研发需按平台要求的结构传。
- 注意1，确保启动游戏的时候正常调用了PCSDK初始化方法后，再调用发日志接口；启动游戏时调用的PCSDK初始化方法有别于安装时调用的方法，无须设置 disable_sdk_act_log 这个参数。
- 注意2，actId 为事件ID，只支持字母，数字，下划线命名，不支持中文。
- 注意3，actName 为事件名称，支持中文。
- 注意4，detail 为需要随本次发生事件一并记录的额外信息，可以是普通字符串，也可以是json字符串，不要包含竖线 | ，总长度不要超过 1000 个字符。

代码示例

    Ourpalm_SendGameInfoLog() {
        var log = { 'roleLevel': '0', 'roleVipLevel': '0', 'actId': 'LoginSceneLoaded', 'actName': '登陆场景加载成功', 'detail': 'begin' };
        var logString = JSON.stringify(log);
        opgamesdk.Ourpalm_SendGameInfoLog("1003", "role-act", logString);
    }

logId和LogKey对应表

7 其他功能接口

7.1 微信小游戏功能接口

7.1.1 支付成功打点（必接）

功能说明
腾讯广告打点事件，用于广告推广，游戏客户端发货时发送支付成功日志

接口定义

    Ourpalm_SendPayEvent(){
        var params = {
            roleId:'121212',
            price:'100',
            propId:'1',
            propName:'1元商品',
            ssId:'23423423423'//掌趣订单号
        }
        opgamesdk.Ourpalm_SendPayEvent(params)
    }

7.1.2 收藏打点（必接）

功能说明
腾讯广告打点事件，用于广告推广，在用户收藏小游戏的时候上报，包括收藏、添加到我的小程序、添加到桌面以及小游戏自己定义的收藏逻辑。

接口定义

    Ourpalm_SendAddToWishListEvent(){
        //wishType 类型枚举值：普通收藏（default）/添加到我的小程序（my）/添加到桌面（desktop）/其他（others）
        opgamesdk.Ourpalm_SendAddToWishListEvent("default")
    }

7.1.3 分享打点（必接）

功能说明
腾讯广告打点事件，用于广告推广，在用户分享小游戏的时候上报，需区分是【转发给朋友】还是【分享到朋友圈】。

接口定义

    Ourpalm_SendShareEvent(){
        //shareType 分享类型枚举：转发给朋友（APP_MESSAGE) / 分享到朋友圈（TIME_LINE）
        opgamesdk.Ourpalm_SendShareEvent("APP_MESSAGE")
    }

7.1.4 GameClub（游戏圈）数据解密

功能说明
用于GameClub（游戏圈）数据

接口定义

opgamesdk.Ourpalm_Channel_Spreads("WxDecryptData",GameClubData)

接口定义

    Ourpalm_GameEntryCallback(methodName, param) {
        if (methodName === "Callback_wxDecryptData") {
            if (param.success === "1") {
               //获取游戏圈数据解密成功
            } else {
               //获取游戏圈数据解密失败
            }
        }
    }
    opgamesdk.Ourpalm_Channel_Spreads("WxDecryptData",GameClubData)

8 附录

8.1 客户端错误码

8.2 用户中心错误码

跳转查询

8.3 计费中心错误码

跳转查询

8.4 货币类型及对应ID

货币ID是没有限定位数的纯自增值，详情：货币类型详情列表