防沉迷

警告

此功能为统计游戏时长，不可将接口返回值作为登录验证的条件。

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

开始游戏接口：游戏服务器调用OmniSDK服务器

退出游戏接口：游戏服务器调用OmniSDK服务器

防沉迷游戏时间到通知游戏接口：OmniSDK服务器调用游戏服务器（游戏需提供通知 URL 给 OmniSDK 进行配置）

开始游戏

玩家开始玩游戏时,游戏服务器通知 OmniSDK，OmniSDK 以该时间作为防沉迷计时的开始。

此接口的发起方为游戏服务器，接收方为 OmniSDK 服务器

• 接口类型：HTTP GET 或 POST
• 使用 POST 方式时，请设置请求头为 Content-Type: application/json;charset=UTF-8

请求地址为：

https://a2.xgsdk.seayoo.com/account/playgame/{omniAppId}

参数说明

Name	Type	Description	Must
type	String	接口类型，固定为字符串：playgame	Yes
uid	String	用户 ID	Yes
platform	String	游戏平台，安卓(a)/IOS(i)，如果两个平台的防沉迷回调地址（通知游戏踢出登录用户）相同，可以不传这个参数	No
ts	String	当前时刻的时间表达式，秒级，如 20150723150028 对应 2015/7/23 15:00:28	Yes
sign	String	详见文档签名与验签，使用 OmniSDK 分配给用游戏的服务端密钥	Yes

​​

返回值

Name	Description
code	返回码请参考防沉迷开始游戏错误码
msg	接口调用信息提示，成功为 success

​​

请求示例

{
    "type": "playgame",
    "uid": "jinshan__001",
    "ts": "20191128160125",
    "sign": "xxxx"
}

响应示例

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

退出游戏

游戏玩家实际退出游戏时，通知 OmniSDK，OmniSDK 以该时间作为防沉迷终止计时。

此接口的发起方为游戏服务器，接收方为 OmniSDK 服务器

• 接口类型：HTTP GET 或 POST
• 使用POST方式时，请设置请求头为 Content-Type: application/json;charset=UTF-8

请求地址为：

https://a2.xgsdk.seayoo.com/account/exitgame/{omniAppId}

参数说明

Name	Type	Description	Must
type	String	接口类型，固定为字符串：playgame	Yes
uid	String	用户 ID	Yes
platform	String	游戏平台，安卓(a)/IOS(i)，如果两个平台的防沉迷回调地址（通知游戏踢出登录用户）相同，可以不传这个参数	No
ts	String	当前时刻的时间表达式，秒级，如 20150723150028 对应 2015/7/23 15:00:28	Yes
sign	String	详见文档签名与验签，使用 OmniSDK 分配给用游戏的服务端密钥	Yes

返回值

Name	Description
code	返回码请参考防沉迷退出游戏错误码
msg	接口调用信息提示，成功为 success

请求示例

{
    "type": "exitgame",
    "uid": "jinshan__001",
    "ts": "20191128160125",
    "sign": "xxxx"
}

响应示例

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

防沉迷游戏时间到通知游戏

OmniSDK 计时防沉迷时间到时通知游戏，可一次多个 UID 通知游戏。

备注

请保证此接口幂等性，OmniSDK 会根据接口的返回值重复进行通知。

此接口的发起方为 OmniSDK 服务端，接收方为游戏服务器，游戏方提供 URL，OmniSDK 服务器主动调用

使用 HTTP POST 方式，请求头为 Content-Type: application/json;charset=UTF-8

参数说明

Name	Type	Description	Must
type	String	接口类型，固定为字符串：anti-addiction-game-expired	Yes
uids	Array	等待被踢下线的 UID 们	Yes
ts	String	当前时刻的时间表达式，秒级，如 20150723150028 对应 2015/7/23 15:00:28	Yes
sign	String	详见文档签名与验签，使用 OmniSDK 分配给用游戏的服务端密钥	Yes

返回值

Name	Description
code	返回码请参考防沉迷退出游戏错误码
msg	接口调用信息提示，成功为 success

请求示例

{
    "type": "anti-addiction-game-expired",
    "uids": [
        "jinshan__001",
        "jinshan__002",
        "jinshan__003"
    ],
    "ts": "20191128160125",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

响应示例

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