接口说明
游戏支持开发者发放自己的奖品,本文介绍如何通过奖品接口发放奖品。
开发者在游戏后台创建虚拟奖品,填写确定奖品标识。
开发者在游戏后台配置虚拟奖品接口地址。
用户参与游戏中奖虚拟奖品后,会调用后台配置的虚拟奖品发放接口,并传递该奖品标识到开发者服务器。
调用方式
游戏平台调用开发者,由开发者提供接口,并配置在游戏后台。
请求 Header
请求 Header 主要包含以下几个 Fields(Field 注意区分大小写)。
Header | 是否必选 | 描述 | 示例值 |
X-Request-Sign | Yes | 本次请求生成的签名,默认为HmacSHA1 | X-Request-Sign:**** |
X-Access-Key | Yes | 游戏平台唯一标识,Superapp 游戏运营后台获取 | X-Access-Key:aBc9a75e |
X-Request-Timestamp | Yes | 时间戳 | X-Timestamp:1720693342650 |
Content-Type | No | 内容格式 | Content-Type: text/html; charset=UTF-8 |
请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
uid | String | 是 | 128 | 用户唯一标识 | 2023122881219846 |
code | String | 是 | 32 | 虚拟奖品配置的接口标识 | ABC74536 |
order_no | String | 是 | 32 | 唯一订单号 | 1710235356493000001 |
desc | String | 是 | 512 | 奖品名称 | 某某商品 |
credits | String | 是 | 32 | 消耗金币 | 100 |
返回参数
参数 | 类型 | 是否必选 | 描述 | 示例值 |
resultCode | String | 是 | 返回码 | SUCCESS |
resultMessage | String | 否 | 返回码描述 | Processing successful |
partnerOrderNo | String | 是 | 唯一订单号 | 1710235356493000001 |
错误码
错误码 | 失败信息描述 | 进一步行动 |
SUCCESS | Processing successful | - |
PROCESS_FAIL | Processing failed | 联系技术支持人员解决问题 |
UNKNOWN_EXCEPTION | An API calling is failed, which is caused by unknown reasons | 尝试重新请求 |
REQUEST_ERROR | Request parameter error | 检查请求参数是否与文档参数一致 |
INVALID_AUTH | Signature verification error | 请参见: 安全机制 |
REQUEST_EXPIRED | Request expired | 检查时间戳参数是否长于5分钟 |
RESPONSE_ERROR | Return parameter error | 检查接口返回的参数是否与文档一致 |
UID_NOT_FOUND | User not found | 检查 uid 参数是否正确 |
SERVICE_EXPIRED | Service expired | 联系技术支持人员解决问题 |