付费系统游戏工作室指南 - gtoken/sdk-download GitHub Wiki
本文用来帮助游戏工作室轻松设置接口证书,以及深入了解付款完成后,GToken付费系统(GPG)回调的响应主体。
##I. 接口证书##
无论您如何将网站或移动应用程序连接到GPG,至少需要提供这些数据来处理付款:
-
接口密钥:客户端特定的公共标识符
-
接口密令:客户端特定的安全标识符,不应该共享 - 即使是我们也不可以!
-
作用范围:指定客户端可以访问的接口组,包括
-
payment:可用于创建付款,结算订单
-
ipay: 可用于Ipay回调
-
verify: 可用于获得支付状态,获得支付回调日志
-
注意:您可以在一个接口证书中选择多个作用范围。
您可以通过执行以下步骤找到这些数据:
-
登录管理员面板
-
进入API Key
-
在Choose Studio Name中选择工作室名称,点击Add key按钮
-
您将被跳转到新页面。选择作用范围,然后单击Create按钮
-
弹出窗口将显示接口密钥和接口密令,请将其秘密保存在某处,然后点击确定
恭喜!您拥有了您的第一个接口证书。
##II. 付费系统回调##
首先,您需要按照以下步骤设置您的付费回调地址
-
登录管理员面板
-
进入Studio,找到您的工作室,点击Edit
-
在Payment Callback Url (POST method)旁边的空格中输入您的付费回调端点,然后点击Update按钮
一旦用户成功付款,GPG将通过POST方法向您定义的端点(上述步骤)发送请求。请求主体包含以下键和值:
键 | 值 | 注释 | |
---|---|---|---|
payment_response | |||
payment_id | 付费的标示符 | ||
amount | 用户为产品支付的总金额 | ||
total_token | 用户为产品支付的总代币 | ||
token | 代币的货币单位 - PTK或者GTK | ||
total_amount | 用户为产品支付的总金额 | ||
currency | 货币 | ||
status | 付款状态 | *executed: 成功执行付款 | |
private_info | 游戏工作室用来传输信息的定制信息 | ||
created_date | Unix时间跨度格式的付款创建日期 | ||
short_description | 付款的说明 | ||
gameitem_responses | |||
transaction_id | 交易的标识符 | ||
game_id | GToken系统中的游戏标示符 | ||
amount | 用户为此次交易所支付的金额 | ||
amount_token | 用户为此次交易所支付的代币 | ||
item_name | 产品名称 | ||
created_date | 交易的时间间隔 | ||
item_id | GToken系统中的产品标示符 | ||
exchange_option_identifier | 游戏工作室系统中的产品标示符 | ||
success | 请求的状态 | ||
error_code | 错误代码 | ||
message | 出错的信息 |
Json 格式
{
"payment_response": {
"short_description": "TEST_0710",
"total_amount": 1,
"total_token" : 1,
"token" : "PTK",
"currency": "USD",
"payment_id": "f757e272-07a8-4fe4-8fd8-82284c2227d8",
"created_date": 1480321150.8414428,
"status": "completed_ok",
"private_info": "secret is secret"
},
"gameitem_responses": [
{
"transaction_id": 3329,
"game_id": "808a4391-4d66-4293-9d2d-06f30d0c5417",
"amount": 1,
"amount_token" : 1,
"item_name": "MGT0710",
"created_date": 1480321150.8414428,
"item_id": 409904333,
"exchange_option_identifier": "TEST TEST"
}
],
"success": true,
"error_code": "",
"message": ""
}
想了解更多关于completed_error状态,您可以转到管理员面板并点击Studios。 找到您的工作室后,点击View callback logs。
##III. 接口 ##
1. 获取付款状态
_ 地址: /api/v1/payments/get-payment-status-for-studio
_ 范围: server-verify
_ 请求对象:
键 | 值 | 注释 | |
---|---|---|---|
payment_id | 付费的标示符 |
_ 响应对象
与“II. 付费系统回调”相同。