防沉迷接入文档

1 文档概述

此文档为西瓜SDK的防沉迷接入和介绍文档: 本文介绍如何在服务端接入

2 分步指南

游戏接入西瓜防沉迷：需要游戏服务端支持3个接口：

1. 开始游戏接口：游戏服务器调用西瓜服务器（可选，接入西瓜时和西瓜约定是否以verify-session时间为准开始防沉迷计时，如果是可以不接入开始游戏接口）
2. 退出游戏：游戏服务器调用西瓜服务器（必接）
3. 防沉迷游戏时间到通知游戏接口：西瓜服务器调用游戏服务器（必接：游戏需要提供通知URL给西瓜后台配置）

2.1 开始游戏

说明：玩家开始玩游戏时,游戏服务器通知西瓜，西瓜以该时间作为防沉迷计时。可选是否调用接口，接入西瓜时和西瓜约定好，如果游戏不调用该接口，西瓜将以游戏调用西瓜verify-session时间为准开始计时。

参数：

返回：

请求示例：

post url : http://{xgsdk服务器域名}/account/playgame/22320043?type=login&uid=jinshan_uid001&ts=20191128160125&sign=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

POST Body:
    {
        "type": "playgame",
        "uid": "jinshan__001",
        "ts": "20191128160125",
        "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }

返回样例：

{
    "code": "0",
    "msg": "success"
}

2.2 退出游戏

说明：游戏玩家实际退出游戏时,通知西瓜，西瓜以该时间作为防沉迷终止计时，必调接口。

参数：

返回：

请求示例：

post url : http://{xgsdk服务器域名}/account/exitgame/22320043/jinshan_uid001?ts=20191128160125&sign=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

POST Body:
    {
        "type": "exitgame",
        "uid": "jinshan__001",
        "ts": "20191128160125",
        "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }

返回样例：

{
    "code": "0",
    "msg": "success"
}

2.3 防沉迷游戏时间到

说明：西瓜计时防沉迷时间到时通知游戏，可一次多个uid通知游戏。当需要通知游戏所有未成年游戏时间到时，出于通知效率考虑，不会将所有未成年玩家uid通知游戏，只设置allUnderAgeGameExpired=1，游戏需要根据verify-session返回的ceritification字段记录所有未成年玩家信息供西瓜通知到所有未成年，游戏能登出所有未成年玩家。

参数：

返回：

请求示例：

http://172.63.55.62:18888/anti-addiction/game-expired

POST Body:
    {
        "type": "anti-addiction-game-expired",
        "uids": ["jinshan__001","jinshan__002","jinshan__003"],
        "ts": "20191128160125",
        "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
    或：
    {
        "type": "anti-addiction-game-expired",
        "allUnderAgeGameExpired": "1",
        "ts": "20191128160125",
        "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }

返回样例：

{
    "code": "0",
    "msg": "success"
}

2.5 verify session 错误码

说明：当防沉迷不能登录时，游戏在调用西瓜verify-session接口时会返回下列code,msg错误信息，游戏要根据返回的错误信息自行处理提示不能登录信息给用户。

2.6 防沉迷不能充值时创建订单返回错误码

说明：当防沉迷不能充值时，游戏可从客户端调用西瓜支付接口时支付失败回调onPayFail的msg字段返回的json值，来提示相关充值失败信息给用户。

msg 为json串：{"code":"-12", "msg":"未满8周岁用户不能充值"}
    {"code":"-13", "msg":"8周岁以上未满16周岁未成年单次充值不得超过50元人民币"}
    {"code":"-14", "msg":"16周岁以上未满18周岁未成年单次充值不得超过100元人民币"}
    {"code":"-15", "msg":"8周岁以上未满16周岁未成年每月充值累计金额不得超过200人民币"}
    {"code":"-16", "msg":"8周岁以上未满16周岁未成年单次充值不得超过50元人民币"}
    {"code":"-17", "msg":"游客不能充值"}

防沉迷不能充值时游戏客户端获取到相关错误信息给玩家弹窗代码示例:

public void onPayFail(PayInfo payInfo, PayResult payResult) {
    String msg=payResult.getMsg();
    try {
        JSONObject jsonObject=new JSONObject(msg);
        String code=jsonObject.getString("code"); //支付失败错误码
        String codeMsg=jsonObject.getString("msg"); //支付失败信息

        if ("-12".equals(code) ||"-13".equals(code) ||"-14".equals(code) ||"-15".equals(code)
            ||"-16".equals(code) ||"-17".equals(code)) {
            //此次游戏可自行决定弹窗提示方式
            ToastUtil.showToastLong(activity, codeMsg);
        }
    } catch (JSONException e) {
      e.printStackTrace();
    }
}

2.7 国家政策参考地址

http://www.sapprft.gov.cn/sapprft/contents/6588/407807.shtml