游戏公告接入说明文档

游戏公告接入说明文档
1. 接入必读
2. 准备工作
3. 接口说明
4. 接口
- 4.1 游戏内滚动公告(跑马灯)获取接口
- 4.2 游戏开屏公告获取接口
附录一（游戏公告接口响应编码定义表）
附录二（接口交互数据checkSum校验规则）

1. 接入必读

该文档主要包含游戏内公告板公告和滚动公告的获取接口定义，接入后可通过掌趣统一后台进行游戏内公告的配置和调整；

2. 准备工作

在掌趣MIS平台上创建需要接入的产品和游戏服；
3. 接口说明

接口协议:HTTP POST;
交互数据格式:请求以Form表单进行提交，输出数据为JSON格式；均以UTF-8进行编码;

4. 接口

4.1 游戏内滚动公告(跑马灯)获取接口

该接口主要功能：支持在掌趣统一后台配置的滚动公告内容列表。需要游戏服通过当前游戏服Id来获取公告内容，支持多条滚动公告同时返回，滚动公告存在滚动播放时间间隔（单位：秒），请游戏服严格按照时间间隔自行实现该功能。建议每个游戏服每5分钟获取一次。

4.1.1 接口地址
- 国内：https://gscservice.gamebean.net/gamemanager/s/getrollingnotice.htm
- 港澳台（包括东南亚地区）：
4.1.2 请求参数

参数名称	类型	限制策略	说明
productId	字符串	必填	平台统一的产品Id。通过运营人员获取
localeId	字符串	必填	平台定义的统一语言地区Id。通过运营人员获取
serverId	字符串	必填	游戏服Id，该游戏服Id必须配置在掌趣平台。
checkSum	字符串	必填	校验码，校验规则参见`附件二`

4.1.3 返回参数

参数名称	数据父节点	类型	说明
status	-	字符串	0：成功； 1：失败；
reset	-	字符串	详细返回码；参见`附件一`
desc	-	字符串	返回描述；
data	-	数组	滚动公告列表
id	data[i]	数字	公告唯一ID
interval	data[i]	数字	滚动间隔时间
content	data[i]	字符串	公告内容（纯文本）

4.1.4 请求示例

http://url?productId=10001073&localeId=01&serverId=601&checkSum=F080C0F6A63EAE9ED07B455F29DDB14D

4.1.5 返回示例

{
"status": "0",
"reset": "1000",
"desc": "",
"data": [
{
"interval": 20,
"id": 20,
"content": "滚动公告测试：内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容内容"
}
]
}

4.2 游戏开屏公告获取接口

该接口主要功能：支持在掌趣统一后台配置的开屏公告内容列表。需要游戏通过当前游戏版本来获取公告内容，支持多条开屏公告同时返回。

4.2.1 接口地址
- 国内：https://gscservice.gamebean.net/gamemanager/s/getunloginnotice.htm
- 港澳台（包括东南亚地区）：
4.2.2 请求参数

参数名称	类型	限制策略	说明
serviceId	字符串	必填	平台统一的serviceId。IOS：通过`网游接入说明`-> `初始化` -> `获取渠道信息接口` 获取。 Android：通过`网游接入说明` -> `其他接口` -> `获取ServiceId` 获取。
localeId	字符串	必填	平台定义的统一语言地区Id。国内传01，非国内通过运营人员获取。
platform	字符串	必填	平台定义的统一的机型平台Id。 Android传”0000” IOS传 “0002”
version	字符串	必填	游戏版本号
checkSum	字符串	必填	校验码，校验规则参见`附件二`

4.2.3 返回参数

参数名称	数据父节点	类型	说明
status	-	字符串	0：成功； 1：失败；
reset	-	字符串	详细返回码；参见`附件一`
desc	-	字符串	返回描述；
data	-	数组	滚动公告列表
id	data[i]	数字	公告唯一ID
title	data[i]	字符串	标题
content	data[i]	字符串	内容

4.2.4 请求示例

http://url?serviceId=1000107331014300000&localeId=01&platform=0000&version=0.3.0&checkSum=23C92305B39FEDF7B9DB62CAD54C1EFA

4.2.5 返回示例

{
"status": "0",
"reset": "1000",
"desc": "",
"data": [
{
"id": 20,
"content": "公告测试：内容内容内容内容内容内容",
"title": "公告测试"
}
]
}

附录一（游戏公告接口响应编码定义表）

响应码	描述
1000	成功
GM401	产品信息非法
GM402	serverId非法
GM403	语言信息非法
GM404	serviceId非法
GM405	机型平台信息非法
GM406	version非法
GM500	其他错误
GM501	checkSum不合法

附录二（接口交互数据checkSum校验规则）

校验规则
参数按照参数名的字典顺序依次取值，若值为空，则不参与签名计算
如：
productId:10001073
localeId:01
serverId:1008

追加后需要计算签名的字符串:
01100010731008

最后需添加产品密钥(产品密匙可从MIS上获取),此处为测试密钥,如:12345453i1rm129rf2s8fy5j80ao0626

最后计算
MD5(0110001073100812345453i1rm129rf2s8fy5j80ao0626)

结果为:D7AC813FDFF2E6AF07808E7DE371D673 注意：MD5需要转大写。

Table of Contents