<h3><strong>一、<strong><strong>API</strong></strong>文档说明</strong></h3> <p>本文档面向与LongSDK进行合作的游戏商。详情如下：</p> <p>1、数据通过HTTP协议传输。</p> <p>2、请求方式：HttpPost。</p> <p>3、数据格式：参数格式（示例：a=XXX&b=XXXX）。</p> <p>4、加密方式：MD5。</p> <p>5、请求参数与返回值编码格式为UTF-8。</p> <p>6、签名方式：MD5(<span style="color:red"><strong>全部</strong></span>非空变量字符串按照字母顺序+server_key) 。</p> <p>7、server_key：<span style="color:red">在对接时向运营人员索取。</span></p> <h3><strong>二、接口详情介绍</strong></h3> <h4><strong>1、推送接口</strong></h4> <p>说明:此接口用于确认游戏中与sdk交易的成功与否,由游戏厂商编写,并告知绝峰对接人员,添加回调地址,当有交易需要确认时, LongSDK会调用相关接口确认交易信息。</p> <p>回调地址 在对接时候 线下发给SDK 开发人员即可。（回调地址请不要携带参数避免出错）</p> <p>（1）接口请求参数说明</p> <table> <thead> <tr> <th><strong>请求参数</strong></th> <th><strong>说明</strong></th> <th><strong>示例</strong></th> </tr> </thead> <tbody> <tr> <td>orderId</td> <td>调用sdk支付接口,返回的订单号[String]</td> <td>orderId=1212121</td> </tr> <tr> <td>gameRole</td> <td>游戏内对应角色唯一id [String]</td> <td>gameRole=2323</td> </tr> <tr> <td>gameArea</td> <td>游戏内区服id[String]</td> <td>gameArea=234</td> </tr> <tr> <td>productName</td> <td>游戏内购买物品定义名称[String]</td> <td>productName=光明礼包2</td> </tr> <tr> <td>productDesc</td> <td>游戏内购买物品定义描述[String]</td> <td>productDesc=光明礼包12元</td> </tr> <tr> <td>remark</td> <td>游戏自定义信息[String]</td> <td><strong>建议传游戏方订单编号，方便数据查询</strong></td> </tr> <tr> <td>payTime</td> <td>玩家在sdk中支付的时间[String]</td> <td>格式：yyyy-MM-dd HH:mm:ss例子：2017-06-13 12:15:30</td> </tr> <tr> <td>amount</td> <td>支付金额[String] （单位：元）</td> <td>amount=10.22</td> </tr> <tr> <td>payWay</td> <td>支付方式[String]</td> <td>payWay=支付宝</td> </tr> <tr> <td>sign</td> <td>请求签名[String]</td> <td>md5(amount=10.22&gameArea=12&gameRole=2323& orderId=1212121&payTime=2017-06-13 12:15:30& payWay=支付宝&productDesc=光明礼包12元& productName=光明礼包2&remark=111server_key)，字符串拼接,**server_key直接拼接**参数直接拼接，然后加密。不做转码或其他处理。</td> </tr> </tbody> </table> <p>（2）接口返回值说明：</p> <table> <thead> <tr> <th>返回值内容</th> <th>表达意义</th> </tr> </thead> <tbody> <tr> <td>success</td> <td>成功收到sdk服务器的交易确认,并确认完成无异议，【小写】</td> </tr> <tr> <td>failed</td> <td>成功收到sdk服务器交易确认,但交易细节有问题,参数确认失败</td> </tr> <tr> <td></td> <td>如果重复收到此消息，且订单已结完成。请直接回复 success</td> </tr> </tbody> </table> <p>……</p> <h4><strong>2、订单查询接口 （<span style="color:red">非必须）</span></strong></h4> <p>说明:此接口用于游戏服务器主动请求LongSDK服务器确认订单信息接口</p> <p>按照游戏方本身的业务选择性接入即可。</p> <table> <thead> <tr> <th>请求地址</th> <th><a href="http://g02.api.yiigames.com/search/order">https://g02.api.yiigames.com/search/order</a></th> </tr> </thead> <tbody> <tr> <td>请求方式</td> <td>HttpPost</td> </tr> <tr> <td>说明</td> <td>根据订单号获取相应的订单信息, server_key由服务端调取</td> </tr> </tbody> </table> <p>（1）接口请求参数说明</p> <table> <thead> <tr> <th><strong>请求参数</strong></th> <th><strong>说明</strong></th> <th><strong>示例</strong></th> </tr> </thead> <tbody> <tr> <td>orderId</td> <td>调用sdk支付接口,返回的订单号[String]</td> <td>orderId=1212121</td> </tr> <tr> <td>sign</td> <td>请求签名[String]</td> <td>md5(orderId=1212121server_key)，字符串拼接</td> </tr> </tbody> </table> <p>（2）接口返回值说明：</p> <table> <thead> <tr> <th><strong>返回值</strong></th> <th><strong>说明</strong></th> <th><strong>示例</strong></th> </tr> </thead> <tbody> <tr> <td>code</td> <td>成功或失败的标识[String]</td> <td>1</td> </tr> <tr> <td>msg</td> <td>结果说明[String]</td> <td>获取成功</td> </tr> <tr> <td>data</td> <td>成功后返回的数据信息</td> <td></td> </tr> <tr> <td>gameRole</td> <td>游戏内对应角色唯一id[String]</td> <td>12</td> </tr> <tr> <td>gameArea</td> <td>游戏内区服id [String]</td> <td>234</td> </tr> <tr> <td>productName</td> <td>游戏内购买物品定义名称[String]</td> <td>大礼包</td> </tr> <tr> <td>productDesc</td> <td>游戏内购买物品定义描述[String]</td> <td>大礼包20元</td> </tr> <tr> <td>remark</td> <td>游戏自定义信息[String]</td> <td></td> </tr> <tr> <td>payTime</td> <td>玩家在sdk中支付的时间[String]</td> <td>格式：yyyy-MM-dd HH:mm:ss例子：2017-06-13 12:15:30</td> </tr> <tr> <td>amount</td> <td>支付金额[String]（单位：元）</td> <td>12.00</td> </tr> <tr> <td>payWay</td> <td>支付方式[String]</td> <td>支付宝</td> </tr> </tbody> </table> <p>成功返回值示例：</p> <pre><code class="language-json">{ "code": "1", "msg": "获取成功", "data": { "gameRole":"###", "gameArea":"###", "productName":"###", "productDesc":"###", "remark":"###", "payTime":"###", "amount":"###", "payWay":"###" } } </code></pre> <p>失败返回值示例：</p> <pre><code class="language-json">{ "code":"400", "msg":"参数缺失orderId为空" } </code></pre> <p>（3）code返回值说明：</p> <table> <thead> <tr> <th><strong>code</strong></th> <th><strong>msg</strong></th> </tr> </thead> <tbody> <tr> <td>0</td> <td>1. 订单不存在1. 获取订单信息失败</td> </tr> <tr> <td>1</td> <td>获取成功</td> </tr> <tr> <td>400</td> <td>参数缺失orderId</td> </tr> <tr> <td>401</td> <td>签名不正确</td> </tr> </tbody> </table> <h2><strong>3、登录token验证接口 （<span style="color:red">可选</span>）</strong></h2> <p>说明:此接口用于玩家在登录后，游戏服务器主动请求sdk服务器验证登录信息接口,<span style="color:red">按照游戏方本身的业务选择性接入即可。</span></p> <table> <thead> <tr> <th>请求地址</th> <th><a href="http://g02.api.yiigames.com/api/cp/user/check">http://g02.api.yiigames.com/api/cp/user/check</a></th> </tr> </thead> <tbody> <tr> <td>请求方式</td> <td>HttpPost</td> </tr> <tr> <td>说明</td> <td>注意：本接口跟其余两个接口的加密参数有点区别本接口：其他参数&app_key=server_key; server_key为对接参数</td> </tr> </tbody> </table> <p>（1）接口请求参数说明</p> <table> <thead> <tr> <th><strong>请求参数</strong></th> <th><strong>说明</strong></th> <th><strong>示例</strong></th> </tr> </thead> <tbody> <tr> <td>app_id</td> <td>游戏id[String]</td> <td>app_id=60079</td> </tr> <tr> <td>mem_id</td> <td>玩家id[String]</td> <td>mem_id=12</td> </tr> <tr> <td>user_token</td> <td>玩家token[String]</td> <td>user_token=49356f14-6dff-43e0-b55a-321de1d87b8a</td> </tr> <tr> <td>sign</td> <td>请求签名[String]</td> <td>md5(app_id=1212121&mem_id=12&user_token=sasa&app_key=server_key)字符串拼接（注意最后有链接符号 &）</td> </tr> </tbody> </table> <p>（2）接口返回值说明：</p> <table> <thead> <tr> <th><strong>返回值</strong></th> <th><strong>说明</strong></th> <th><strong>示例</strong></th> </tr> </thead> <tbody> <tr> <td>status</td> <td>成功或失败的标识[String]</td> <td>1</td> </tr> <tr> <td>msg</td> <td>结果说明[String]</td> <td>获取成功</td> </tr> </tbody> </table> <p>成功返回值示例：</p> <pre><code class="language-json">{ "status":"1", "msg":"验证成功" } </code></pre> <p>失败返回值示例：</p> <pre><code class="language-json">{ "status":"11", "msg":"app_id错误" } </code></pre> <p>（3）status返回值说明：</p> <table> <thead> <tr> <th><strong>status</strong></th> <th><strong>msg</strong></th> </tr> </thead> <tbody> <tr> <td>1</td> <td>验证成功</td> </tr> <tr> <td>11</td> <td>app_id错误</td> </tr> <tr> <td>12</td> <td>签名错误</td> </tr> <tr> <td>14</td> <td>Token不存在或已失效</td> </tr> </tbody> </table>