GHOME SDK 文档 - 支付中心

# 平台对外接口调用协议定义（HPS）

接口通过HPS(http get + MD5验签)协议接入，需要授权访问。授权联系人：王智涛； 接口联系人：杨文伟

hps协议接入标准请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
merchant_name 接入用户名,接入用户名从接入平台获取 query true string
signature_method 签名方法,目前固定传 MD5 query true string
signature 签名(详见 HPS请求签名算法) query true string
timestamp 时间戳 query true string
xxx 业务参数 query true int

HPS请求签名算法

  1. 当前请求参数名的字母序进行升序排列（排序时区分大小写，signature和value为空的参数不参与签名）;
  2. 将所有参数-值组合以 key=value 的形式拼成一个新字符串，不同参数值之间没有任何分隔符；
  3. 最后加上对应的签名密钥 secretKey(此密钥在接入时由王智涛方提供给游戏相关接入人员) 后进行MD5哈希运算。如MD5方法的输入的字符串为：key1=value1key2=value2secretKey；

# 获取游戏所有区列表（queryAreaList）

接口地址:/gipp/queryAreaList (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

获取游戏所有区列表

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
channelType 认证系统的渠道标识 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
appId 游戏id query true string
pageNo 当前页数，不允许为0或小于-1 query true int
pageCount 每页行数，默认20 query false int
isShowHidden 是否获取隐藏区1=获取0=不获取。默认为0 query true int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  recordCount 总记录数 int
  areaList 区信息 OrderArray Array

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
        "resultCode": 0,
	    "resultMsg": "",
		"recordCount": 2,
		"areaList":[{"areaId":"1","areaName":"区1"},{"areaId":"2","areaName":"区2"}]
	}
}
1
2
3
4
5
6
7
8
9
10

# 获取用户在指定区服的角色列表(queryUserRoles)

接口地址:/gipp/queryUserRoles (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

获取用户在指定区服的角色列表

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
channelType 认证系统的渠道标识 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
appId 游戏id query true string
areaId 区id query true string
groupId 组id query false string
userId 用户信息，与userIdType合用 query true string
userIdType 1：mid(手游) ptid（端游）2：sndaId 3：渠道账号Id 4：appMid 99:游戏帐号 query true string

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  roleList 角色列表 OrderArray Array

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
        "resultCode": 0,
	    "resultMsg": "",
		"areaList":[{"groupId":"1","groupName":"测试1服","roleId":"111111","roleName":"demo1"},{"groupId":"1","groupName":"测试1服","roleId":"222222","roleName":"demo2"}]
	}
}
1
2
3
4
5
6
7
8
9

# 礼包领取（码兑换、返利）接口(packageOrder)

接口地址:/gipp/packageOrder (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

礼包领取（码兑换、返利）接口

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
channelType 认证系统的渠道标识 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
appId 游戏id query true string
areaId 区id query true string
groupId 组id query false string
giftType 领取类型 1:兑换码 2:批次 3:返利 query true int
giftCode 与giftType合用, giftType=1时此参数传兑换码;
giftType=2时传入礼包Id(packageId);
giftType=3时 必须传入返利礼包Id		 query true string
activityCode 活动代码：便于查询统计 query false string
orderDate 领取日期 格式为“yyyy-MM-dd” query true string
userId 用户信息，与userIdType合用 query true string
userIdType 1:mid(手游)ptid（端游）2:sndaId 3:渠道账号Id 4:appMid 99:游戏帐号。
目前手游传给游戏的只有4。在其他端（如web）调用时，能获取appMid的情况下优先传appMid		 query true string
roleId 游戏角色Id query true string
roleName 游戏角色名称 query true string
extend 扩展字段(json), 游戏方如需使用此字段，请与GIPP平台开发沟通协调 query false string
deliverExtend 发货扩展信息 query false string
deliveTarget 发货地址(默认从配置库读取) query false string
deliverProtocol 发货协议(默认从配置库读取) query false string
endpointDeviceId 客户终端端设备ID query false string
endpointType 1=安卓、2=IOS、3=PAD、4=PC、-1=未知 query true int
endpointIp 终端请求IP query true string
version 目前请写死：1.0.0 query true string

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  uniqueId 推送订单号，不可重复 string
  orderId 发货唯一凭证(gipp订单号) string
  packageId 礼包ID int
  packageName 礼包名称 string
  giftCode 绑定兑换码列表。以“,”（英文逗号）分割 string
  resultExtend 响应扩展信息 string

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"uniqueId":"8904202404181424025d8afe49S266bS",
			"orderId":"G2010127026169240418142453000001",
			"packageId":58048,
			"packageName":"页面活动",
			"giftCode":"58048",
			"resultExtend":""
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 礼包编号校验接口(checkPackageId)

接口地址:/gipp/checkPackageId (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

礼包编号校验接口

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
channelType 认证系统的渠道标识 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
appId 游戏id query true string
areaId 区id query false string
groupId 组id query false string
packageId 礼包编号 query true int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  packageName 礼包名称 string
  packageIcon 礼包图标URL string
  packageType 礼包类型：1:兑换码 2:批次 3:返利 int
  memo 备注说明 string
  itemInfo 礼包中配置的道具信息(Json格式) json

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"packageName":"活动1"
			"packageIcon":"http://127.0.0.1/packageicon.jpg",
			"packageType":1,
			"memo":"",
			"itemInfo":[
				{"itemCode":"1001","itemNum":"1","itemIcon":"http://127.0.0.1/item.png","itemName":"itemdemo1"},
				{"itemCode":"1002","itemNum":"1","itemIcon":"http://127.0.0.1/item2.png","itemName":"itemdemo2"}
			]
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 礼包发放查询接口(queryPackageOrder)

接口地址:/gipp/queryPackageOrder (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

礼包发放查询接口

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
orderId 发放唯一凭证(gipp订单号) query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
channelType 认证的渠道标识 query true string
appId 游戏id query true string
areaId 区id query true string
groupId 不区分游戏组时传空 query false string

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  uniqueId 请求编号 string
  orderId 发放唯一凭证(gipp订单号) string
  platform 平台标识：2：安卓，3：iOS，-1：未知 int
  channelType 认证的渠道标识 string
  appId 游戏id string
  areaId 区id string
  groupId 不区分游戏组时传空 string
  giftType 礼包类型 string
  giftCode giftType=1时此参数为兑换码;giftType=2时为礼包Id(packageId) string
  deliverResult 发货结果 1=已发货 0=未发货 int
  deliverTime 发货成功时间。yyyy-MM-dd HH:mm:ss string

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"uniqueId":"KCUICGGG0KWBL4COIR8Q1",
			"channelType":"-1",
			"platform":-1,
			"appId":"1002019",\
			"areaId":6,
			"groupId":2,
			"orderId":"G201012702616824041715001402",
			"giftType":1,
			"giftCode":"2869",
			"deliverResult":1,
			"deliverTime":"2024-04-17 15:00:19"
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 获取角色appMid(queryAppMid)

接口地址:/gipp/queryAppMid (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

本接口用于第三方渠道用户在官方或叨鱼活动页面领取礼包时使用

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
orderId 发放唯一凭证(gipp订单号) query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
channelType 认证的渠道标识 query true string
appId 游戏id query true string
areaId 区id query true string
groupId 不区分游戏组时传空 query false string
roleId 游戏角色标识 query true string
roleIdType 游戏角色标识：1=角色ID 2=角色名称 query true int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  appMid appMid string

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"appMid":"111111"
	}
}
1
2
3
4
5
6
7
8
9

# 返利查询接口（queryUserRebate）

接口地址:/gipp/queryUserRebate (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

用于查询用户返利数量(只返回未领取返利)

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
channelType 认证的渠道标识 query true string
appId 游戏id query true string
areaId 区id query true string
groupId 不区分游戏组时传空 query false string
userId 用户账号，与userIdType合用 query true string
userIdType 账号类型, 目前只支持传4 (appMid) query true int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  rebateInfo 返利信息 jsonArray

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"rebateInfo":[{"packageId":"1","amount":"10","packageName":"钻石"},{"packageId":"2","amount":"1","packageName":"金币"}]

	}
}
1
2
3
4
5
6
7
8
9
10

# 获取游戏下配置的普通礼包信息（queryPackageList）

接口地址:/gipp/queryPackageList (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

本接口只能用于查询普通礼包信息(gifttype=2)

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query false int
channelType 认证的渠道标识 query false string
appId 游戏id query true string
pageNo 当前页数，不允许为0或小于-1 query true int
pageCount 每页行数，默认20 query false int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  recordCount 总记录数 string(string)
  packageList 礼包信息 jsonArray

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"recordCount": 2,
			"packageList":[{"packageId":"1","amount":"10","packageName":"钻石"},{"packageId":"2","amount":"1","packageName":"金币"}]

	}
}
1
2
3
4
5
6
7
8
9
10
11

# 获取游戏组列表（queryGroupList）

接口地址:/gipp/queryGroupList (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

目前本接口只支持FF14、AION 2款游戏查询区下的游戏组

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
platform 平台标识：2：安卓，3：iOS，-1：未知 query true int
channelType 认证的渠道标识 query true string
appId 游戏id query true string
areaId 区id query true int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  recordCount 总记录数 string(string)
  groupList 组信息 jsonArray

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"recordCount": 2,
			"groupList":[{"groupId":"1","groupName":"组1","world":LaNuoXiYa"},{"groupId":"2","groupName":"组2","world":ShenYiZhiDi"}]

	}
}
1
2
3
4
5
6
7
8
9
10
11

# 查询领奖码信息（awardQuery）

接口地址:/itemgate/awardQuery (完整接口地址，请联系杨文伟)

请求方式:GET

响应数据类型:*/*

接口描述:

目前本接口只支持彩虹岛获取领奖码信息

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
uniqueId 请求编号 query true string
serviceId 游戏appId query true string
patchId 批次号，多个用","分隔 query true string
userId 用户id query true string
userType 账号类型 query true int

响应参数:

参数名称 参数说明 类型 schema
return_code 响应代码 int
return_message 响应信息 string
data 响应数据(object) Object
  resultCode 返回代码 integer(int32)
  resultMsg 返回信息 string(string)
  award_codes 领奖码信息 jsonArray

响应示例:

{
	"return_code": 0,
	"return_message": "success",
	"data": {
			"resultCode":0,
			"resultMsg":"",
			"award_codes":[
				{"patch_id":"1","item_id":"1001","item_name":"item1","item_num":1,"item_attr":"0","award_code":"11111"},
				{"patch_id":"2","item_id":"1003","item_name":"item3","item_num":1,"item_attr":"0","award_code":"22222"}
			]

	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
Last Updated: 2024/12/19 10:35:38

← 接入方需提供接口 API 说明 →