API文档介绍

本部分主要提供 “SDK 服务器”和游戏合作商“游戏服务器”的交互的接口规范。

协议说明

通信协议

“SDK 服务器”采用HTTP 协议作为通信协议。
“游戏服务器”通过构造HTTP 请求（POST方式）向“SDK 服务器”发起接口请求。

数据协议

• 数据格式
  响应消息的内容都使用json 格式表示数据，须采用utf-8 字符编码。
• 签名规则
  使用md5 签名

接口说明

验证登录user_toke是否有效

接口定义

• 请求地址：
  https://sdk2.xiaokr.cn/sdk/checkUsertoken.php
• 请求方式:
  HTTP/POST
• 请求方:
  游戏服务器
• 响应方:
  SDK服务器
• 接口描述:
  验证user_token是否为有效的登录用户会话，若有效则返回其账号标识、账号创建者和昵称。"游戏客户端"通过"SDK 客户端"获取到user_token，传到"游戏服务器"，"游戏服务器"到"SDK 服务器"验证user_token的有效性。

请求参数

JSON/UTF-8格式

完整示例

HTTP 请求的body 内容：
{
    "app_id":"1",
    "mem_id":"23s",
    "user_token":"rkmi2huqu9dv6750g5os11ilv2",
    "sign":"4753dce3ae736e7f894ebcc6cd3cff7a"
}  

1、假定：app_key = de933fdbede098c62cb309443c3cf251

2、sign 的签名规则：md5(app_id=...&mem_id=...&user_token=...&app_key=...)
替换...为实际值

3、签名原文：
app_id=1&mem_id=23&user_token=rkmi2huqu9dv6750g5os11ilv2&app_key=de933fdbede098c62cb309443c3cf251

4、md5加密：
echo -n "app_id=1&mem_id=23&user_token=rkmi2huqu9dv6750g5os11ilv2&app_key=de933fdbede098c62cb309443c3cf251"|md5sum  
加密结果：4753dce3ae736e7f894ebcc6cd3cff7a

响应结果

{
    "status":"1",
    "msg":"用户已登录"
}

status 为状态码 msg 为状态码说明

状态码

支付回调接口

接口定义

• 请求地址：
  即充值结果通知地址，由CP提供。游戏接入时，录入到的游戏平台中
• 请求方式:
  HTTP/POST
• 请求方:
  SDK服务器
• 响应方:
  游戏服务器
• 接口描述:
  请求方为SDK 服务器，响应方为CP服务器。
  用户在游戏中提交购买请求后，SDK服务器会异步执行充值购买，在购买操作完成后，SDK服务器通过该接口将充值结果发送给“游戏服务器”。
  此处定义本接口的规范，游戏合作商需根据此规范在“游戏服务器”实现本接口。

请求参数

JSON/UTF-8格式

完整示例

HTTP 请求的body内容：
{
    "order_id":"1465718712348234627",
    "mem_id":"24627",
    "app_id": "1",
    "money": "1.00",
    "order_status": "1",
    "paytime":"1465718712",
    "attach":" attach ",
    "sign":"51295343ac734a32e1ef0196c2e82870"
}

1、假定：app_key = 901f6984e638c2f96ef48675b6a32a73

2、sign的签名规则：md5(order_id=...&mem_id=...&app_id=...&money=...&order_status=...&paytime=...&attach=...&app_key=901f6984e638c2f96ef48675b6a32a73s)
(替换...为实际值)

3、签名原文：
order_id=1465718712348234627&mem_id=24627&app_id=1&money=1.00&order_status=1&paytime=1465718712&attach=attach

4、md5加密：
echo -n 'order_id=1465718712348234627&mem_id=24627&app_id=1&money=1.00&order_status=1&paytime=1465718712&attach=attach&app_key=901f6984e638c2f96ef48675b6a32a73'|md5sum
加密结果：51295343ac734a32e1ef0196c2e82870

响应结果

通知机制

充值操作完成后，不论是否充值成功，“SDK 服务器”都会将充值结果通过“充值结果回调接口”发送到“游戏服务器”。“游戏服务器”收到“SDK 服务器”的充值通知后，根据处理结果返回字符串SUCCESS 或FAILURE。如果返回SUCCESS，则“SDK服务器”结束通知任务；如果返回FAILURE 或由于网络延时导致“SDK 服务器”没有收到任何返回，SDK 服务器将会在周期内进行重复通知。

开发要点

user_token 验证注意事项

user_token验证应该在客户端接到sdk 登录成功后，客户端再登录游戏服务器的时候，游戏服务器请求sdk 服务器验证。

user_token 充值结果回调注意事项

在充值完成之后，SDK服务器会回调CP 给的地址。