下载文档

最后更新时间: 2021-02-04 03:12:47 PM

礼包码接入

获取礼包码接口

简要描述

  • 获取礼包码接口(后端调用,不要暴露给前端)

获取接口

请求域名

请求URL:

GET:/api/code

参数

参数名 是否必须 类型 说明
account string 前缀+内部账号,平台用户唯一标识
app_id string 渠道app_id,礼包码后台配置,用于区分使用平台
platfrom_gift_id int 平台礼包编号
time int 时间戳(秒)
sign string 签名,具体方法请见sign算法,key为后台配置的渠道app_key
token string jwt形式的token,有效期3分钟,失效后重新调用/api/token重新获取。失效错误码参考状态码。延长有效期调用用/api/token-refreshment。调用延长有效接口时返回错误(只能延长在有效期内的token,且会返回新的token)则重新调用/api/token获取。token建议调用方业务服务器保存至缓存或者下发给用户端由用户端每次请求带回再由调用方透传至礼包码服务器

返回示例:

正确时返回:

{
    "code": 0,
    "msg": "Success",
    "data": {
        "code": "BIJXKQONWX5"
    }
}

Code

Copy

错误时返回:

{
  "code": 35
   "msg": "Token is expired"
}

使用礼包码接口

简要描述

  • 使用礼包码接口(后端调用,不要暴露给前端)

请求域名

请求URL:

POST:/api/code/use-code

参数

参数名 是否必须 类型 说明
account string 前缀+内部账号,平台用户唯一标识
app_id string 渠道app_id,礼包码后台配置,用于区分使用平台
code string 礼包码,游族后台生成
op_id int 运营商编号,游族定义,通过接口获取。注意手游使用的是开服系统的op_id,即运营商ID,并非opgame_id。
game_id int 游戏编号,游族定义,通过接口获取
server_id long 游戏区服编号
role_id string 角色ID
ex_param1 string 扩展参数,调用方根据需要使用
ex_param2 string 扩展参数,调用方根据需要使用
sign string 签名,具体方法请见sign算法,key为后台配置的渠道app_key

返回示例:

正确时返回:

{
  "code": 0,
   "msg": "领取成功"
}

Code

Copy

错误时返回:

{
  "code": 1,
   "msg": "领取失败"
}

Code

Copy