后台接口概览
Player Network 提供了一整套后台接口来支持业务运营。要访问这些后台接口,请先 在 Player Network 控制台配置您的游戏。
警告
不要在 Player Network SDK 正式环境中进行压力测试。如果游戏需要对自身模块进行压力测试,建议模拟 Player Network SDK 的认证请求。如需压测账号服务,请提前联系 Player Network 助手。
基本结构
- 接口协议:HTTPS
- 字符编码:UTF-8
- 标头:
Content-Type: application/json
- 接口超时时间:8,100 ms
- 服务器 URL:取决于在 Player Network 控制台中配置的部署集群。从控制台 获取部署集群信息 来找到业务所需的服务器 URL。
URL 格式
后台接口请求的标准 URL 格式为:
https://test.intlgame.com/v2/auth/verify_login?os=1&gameid=11&channelid=1&ts=1528097722&sdk_version=0.1&sig=xxx
\_______________________/\___________________/ \______________________________________________________________/
服务器 URL 端点路径 查询参数
鉴权
Player Network 后台接口使用 hash 码来验证请求。有关 hash 值(sig
参数)的更多信息,请联系 Player Network 助手。
查询参数
参数 | 类型 | 说明 | 备注 |
---|---|---|---|
os | string | 操作系统标识 1:Android 2:iOS 3:Web 4:Linux 5:Windows 6:Nintendo 7:Mac 8:PlayStation 9:Xbox | 必填 |
gameid | string | Player Network 分配的游戏 ID | 必填 |
channelid | int | 登录渠道 ID 1:WeChat 2:QQ 3:Guest 4:Facebook 5:GameCenter 6:GooglePlay 9:Twitter 10:Garena 14:LINE 15:Apple 19:VK 20:Xbox 21:Steam 24:Epic 26:Discord 27:PlayStation 5 30:DMM 32:SquareEnix 33:Supercell 35:Kakao 38:VNG 41:Nintendo Switch | 必填 |
ts | uint | Unix 时间 | 必填 |
sig | string | 用于验证请求的 hash 值,请联系 Player Network 助手了解详情 | 必填 |
source | int | 访问来源 0 或留空:客户端 SDK 1:游戏后台 | 必填 |
sdk_version | string | 携带的 SDK 版本 默认为空 | 客户端调用都需要带上 |
seq | string | 透明传输的参数 包含在返回的 JSON 字符串中,用于异步调用 只允许英文字母、数字和下划线(_) 默认为空 | 选填 |
请求示例
curl -sS -X POST -H 'Content-Type: application/json' 'https://test.intlgame.com/v2/auth/verify_login?channelid=11&gameid=11&os=5&source=0&ts=1590481177&sdk_version=2.0&sig=9d3a9c7257d445ae0b1ff31a4d69c16e'
-d '{"openid":"5574152457717116678","token":"1d9d1dea1c094be1ddfeb9ef48f7f0aad72b5a8b"}'
Token 长度
在不同的场景下 token 的长度不同,目前 token 的长度不会超过 2048 bytes。由于后续规划 token 长度上限可能会发生变化,建议您的应用支持长度可变的 token。
回包及错误描述
通过 HTTP 协议发送数据以后,获取状态码。如果状态码不为 200
,则表示请求失败,直接打印结果查看问题。如果状态码为 200
,则表示请求正常,即可以获取 HTTP 返回的内容,将 JSON 字符串解析成数组。
回包格式如下:
{
"ret": 0,
"msg": "user is logged in"
}
- ret = 0,表示请求成功。可以解析相关返回字段信息。
- ret != 0,表示请求逻辑失败。
msg
里面有具体错误信息,没有其它字段返回。
完整的 ret
值列表,请参见 后台错误码。