跳到主要内容
版本:v4

直达礼包接口文档(厂商侧实现)

直发礼包获取游戏区服列表

该接口用于获取指定区服(如果有区服概念)的游戏角色数据。如果游戏支持多个区服,则需要传入 server_id 来指定查询的区服;如果游戏没有区服概念,则无需传入 server_id 参数。

注意
  • URL/direct-gift/v1/get-server-list (path 仅供参考,后台配置时须配置完整带path的请求地址)
  • MethodGET
  • 需要鉴权:是

请求参数

注意

公共参数见 接口公共说明  文档

     
参数名类型必须描述
fromint用于指定查询开始的起点。例如 from=0 表示从第 1 条记录开始返回。
limitint翻页参数,每页的数量
openidstringTapTap OpenID
unionidstringTapTap UnionID

成功响应

注意

条件:请求参数合法,并且验签通过。 状态码200 OK 响应示例:返回游戏列表信息

{
"code": 0,
"msg": "OK",
"data" : {
"servers": [
{
"server_id": "string", // 游戏服 ID
"server_name": "string" // 游戏服名称
}
],
"total": 0
}
}

错误响应

{
"code": 510008,
"msg": "some errors"
}

直发礼包获取游戏该区服下角色列表

该接口用于获取指定区服(如果有区服概念)的游戏角色数据。如果游戏支持多个区服,则需要传入 server_id 来指定查询的区服;如果游戏没有区服概念,则无需传入 server_id 参数。

注意
  • URL/direct-gift/v1/get-role-list(path 仅供参考,后台配置时须配置完整带path的请求地址)
  • MethodGET
  • 需要鉴权:是

请求参数

注意

公共参数见 接口公共说明  文档

     
参数名类型必须描述
server_idstring用户选择的区服 ID
openidstringTapTap OpenID
unionidstringTapTap UnionId

请求示例

/direct-gift/v1/get-role-list?server_id=1&openid=aaaaaaaaa&unionid=aaaaaaaaaa

成功响应

注意
  • 条件:请求参数合法,并且验签通过。
  • 状态码200 OK
  • 响应示例:返回用户在该服务下的角色列表
{ 
"code": 0,
"msg": "OK",
"data": {
"roles": [
{
"id": "string", // 角色 ID
"name": "string", // 角色名称
}
]
}
}

错误响应

{
"code": 510008,
"msg": "some errors",
}

直发礼包发送接口

TapTap 侧已登录的用户通过此接口获得直发礼包。

注意
  • URL/direct-gift/v1/send-gift-package (path 仅供参考,后台配置时须配置完整带path的请求地址)
  • MethodPOST
  • 需要鉴权:是

请求参数

注意

无额外 query parameters,公共参数见接口公共说明 文档

需要保证幂等

请求示例

{ 
"openid": "aaaaaaaaaaaaaaa",
"unionid": "aaaaaaaaaaaaaaa",
"server": "1",
"role_id": "aaaaaaaaa",
"gift_code": "123456"
}

成功响应

注意
  • 条件:请求参数合法,并且验签通过。
  • 状态码200 OK
  • 响应示例:发送直发礼包结果
{
"code": 0,
"msg": "OK",
}

错误响应

{
"code": 510008,
"msg": "server error",
}

直发礼包错误码表

详见 接口公共说明 - 错误码表