基础运营数据接入API手册
1.引言
1.1 概述
运营分析统计后台为游戏开发者提供统一服务端调用接口和客户端SKD接入,游戏开发商可以根据对应的数据接口来获得相应的请求参数。主要用于帮助手机游戏开发商、运营商采集并分析游戏数据,并以行业标准指标和模型来帮助开展深度的追踪分析服务。
1.2 适用对象及范围
适用于策划人员、系统设计人员、开发工程师和测试工程师。
1.3管理后台配置内容
无
2. API方法介绍
服务端 请求url :
http://uapi.uzone8.com/gs/{type}/{method}/{appId}/{serverId}/{timestamp}/{key}
Type: 数据类型(例如:game、data...)
Method:调用方法名称(例如:login、role_consumption、recharge.... )
appId:游戏唯一标识
serverId:区服唯一标识
Timestamp:请求时间戳
Key:验证加密串
POST数据内容放入body内直接提交
注意:account 如果有UID的情况下使用渠道UID,如果没有的情况下使用渠道account,需保证与客户端发送的account同步
2.1基础运营分析接口(必须)
2.1.1.开启服务器汇报(type:data)
接口描述:
参考URL:http://uapi.uzone8.com/gs/data /server_open /{appId}/{serverId}/{timestamp}/{key}
DEMO:http://uapi.uzone8.com/gs/data/server_open/8/2/1446726448/6bdfc7c12070fdd49a967b50a27de539
触发时间:服务器开启时异步请求(最好每次开启都请求一次,会将首次请求作为服务器开启时间)
请求方式:POST
请求参数:
参数类型 | 内容 |
urlencode(Json) |
{ "amount":"1", "data": [{ "server_name":"飞龙在天", "server_ip":"192.168.1.1", "open_dateTime":"2015-01-01 10:00:00", "testMark":"0", "remark":"", "timestamp":"1460039400" }] } |
参数介绍
2.1.2.游戏角色登陆日志 (type: game)
接口描述:
参考URL:http://uapi.uzone8.com/gs/game /login/{appId}/{serverId}/{timestamp}/{key}
DEMO:http://uapi.uzone8.com/gs/game/login/8/1/1446726448/63a2358e8bdfd052d0644d84a78dbf6
方法名称:login
触发时间:游戏角色登陆后调用
请求方式:POST
请求参数参考:
参数类型 | 内容 |
Urlencode(Json) |
{ "amount": "2", "data": [ { "opid":"10022", "account":"f77a522c-fa06-4933-9cd0-39dac0494", "role_id":"121101", "role_name":"战斗狂人", "level":"52", "ip":"192.168.1.1", "remark":"", "timestamp":"1459513317", }, { "opid":"10061", "account":"d77a532c-ea07-2633-ce2d1-43dac8888", "role_id":"133511", "role_name":"羞涩小刀", "level":"48", "ip":"192.168.1.1", "remark":"", "timestamp":"1459513388", }, …… ] } |
参数介绍:
2.1.3.游戏角色在线人数统计(type: game)
接口描述:
参考URL:http://uapi.uzone8.com/gs/game /online /{appId}/{serverId}/{timestamp}/{key}
DEMO:http://uapi.uzone8.com/gs/game/online/8/1/1446726448/d9a2358e8bdfd052d06b4d224a78dbf9
触发时间:游戏角色登陆后,每5分钟调用一次
请求方式:POST
请求参数:
参数类型 | 说明 | 是否必填 |
urlencode(Json) |
{ "amount": "2", "data": [ { "opid":"10312", "people":"2451", "remark":"备注", "timestamp":"1460039400" }, { "opid":"10312", "people":"1581", "remark":"备注", "timestamp":"1460039400" }, …… ] } |
是 |
参数介绍
参数名称 | 介绍说明 | 参数类型 | 是否必填 |
amount | 本次请求记录总条数 | Int | 是 |
data | 本次请求的数据详情 | Json | 是 |
opid | 渠道ID | Int | 是 |
people | 实时在线人数 | Int | 是 |
remark | 备注 | String | 否 |
timestamp | 统计人数时间戳(单位秒) | Int | 是 |
2.1.4.游戏角色充值日志(type: game)
接口描述:
参考URL:http://uapi.uzone8.com/gs/game /recharge/{appId}/{serverId}/{timestamp}/{key}
DEMO:http://uapi.uzone8.com/gs/game/recharge/8/1/1446726448/d9a2358e8bdfd052d06b4d224a78dbf6
方法名称:recharge
触发时间:游戏角色充值到账后调用
请求方式:POST
请求参数:
参数类型 |
内容 |
urlencode(Json) |
{ "amount": "2", "data": [ { "opid":"10321", "account":"f77a522c-fa06-4933-9cd0-39dac0494", "role_id":"121101", "role_name":"战斗狂人", "cp_orderid":"25564413645_10_32145_54124", "op_orderid":"1456991329217_1_1000755_0", "money":"88", "gold":"880", "order_type":"2",
"order_type_name":"月卡", "goodsAmount":"0", "gift":"0", "level":"48", "ip":"192.168.1.1", "remark":"", "timestamp":"1457230815" }, { "opid":"10421", "account":"d77a532c-ea07-2633-ce2d1-43dac8888", "role_id":"13981", "role_name":"羞涩小刀", "cp_orderid":"sdfer8a_10_521_asf1234se", "op_orderid":"1457073204_1_1000522_0", "money":"6", "gold":"60", "order_type":"1",
"order_type_name":"普通充值", "goodsAmount":"0", "gift":"0", "level":"52", "ip":"192.168.1.1", "remark":"", "timestamp":"1456923169" }, …… ] } |
参数介绍
参数名称 | 介绍说明 | 参数类型 | 是否必填 |
amount | 本次请求记录总条数 | Int | 是 |
data | 本次请求的数据详情 | Json | 是 |
opid | 渠道ID | Int | 是 |
account | 账号ID(渠道uid,无渠道uid则渠道账号) | String | 是 |
role_id | 角色ID | Int | 是 |
role_name | 角色名称 | String | 是 |
cp_orderid | 研发商订单号 | String | 是 |
op_orderid | 渠道订单号 | String | 是 |
money | 充值金额 | Int | 是 |
gold | 充值金币 | Int | 是 |
order_type | 订单类型(例如 1.普通充值,2.月卡,3.年卡等) | Int | 是 |
order_type_name | 订单类型名称 | String | 是 |
goodsid | 购买物品ID | Int | 否 |
goodsAmount | 购买物品数量 | Int | 否 |
gift | 赠送点卷 | Int | 否 |
level | 玩家当前等级 | Int | 是 |
ip | 玩家充值IP | String | 是 |
remark | 备注 | String | 否 |
timestamp | 玩家充值时间戳(单位秒) | Int | 是 |
2.1.5.角色在线时长日志 (type: game)
接口描述:
参考URL:http://uapi.uzone8.com/gs/game /inline_time/{appId}/{serverId}/{timestamp}/{key}
DEMO:uapi.uzone8.com/gs/game/inline_time/8/1/1446726448/d9a2358e8bdfd052d06b4d224a78dbf8
触发时间:游戏角色登出后调用
请求方式:POST
请求参数参考:
参数介绍
参数名称 | 介绍说明 | 参数类型 | 是否必填 |
amount | 本次请求记录总条数 | Int | 是 |
data | 本次请求的数据详情 | Json | 是 |
opid | 渠道ID | Int | 是 |
account | 账号ID(渠道uid,无渠道uid则渠道账号) | String | 是 |
role_id | 角色ID | Int | 是 |
onlinetime | 角色在线时间(单位秒) | Int | 是 |
level | 角色等级 | Int | 是 |
ip | 登录IP | String | 是 |
remark | 备注 | String | 否 |
timestamp | 角色登出时间戳(单位秒) | Int | 是 |
3. API接入使用规则
3.1 签名规则
参数的key值是由appId(游戏唯一标识)+ serverId(区服唯一标识)+timestamp(请求时间戳)+appkey(秘钥) 接后urlencode,再MD5生成
服务端:MD5(urlencode(appId+ serverId+timestamp+appkey))
例如 : MD5(urlencode(10+ 109 + 1446559558+5dc88420542eecc75c9c11ff0cc9fd8))
注意 : 1、“appId+ serverId+timestamp+appkey”中的 加号 为拼接符;
2、签名前需要先urlencode;
3、请严格按照以上拼接顺序;
4、md5 为32位小写
3.2 请求规则
服务端数据是以HTTP的post方式,请求接口URL发送数据;
数据放在HTTP的body中;
3.3 返回参数
返回格式:json
返回参数
参数名称 | 参数类型 | 说明 |
statusCode | Int |
错误码 200:成功 201:serverId无效 202:方法类型或方法名称为空 203:方法类型或方法名称无效 204:参数不完整 205: 签名错误 206:data数据非json格式 207:json数据参数错误 208: appID无效 999:其他错误 |