付款金額驗證 API
'付款金額驗證' API 支援當使用者想要購買因網店商品折扣或優惠券應用而改變金額的商品時,使用遊戲伺服器發出的驗證金鑰來驗證折扣付款金額。當使用有效驗證金鑰進行付款時,遊戲伺服器最終可以提供商品。
操作流程¶
這解釋了從呼叫'付款金額驗證' API 到最終商品提供的整體處理順序和系統間處理過程。
Hive 伺服器和應用程式伺服器之間的操作和資料流程如下:
- 使用者操作:在 Hive 網店中購買因折扣或優惠券應用而產生折扣金額的商品時,會呼叫'付款金額驗證' API。
- Hive 伺服器:向 Hive 控制台 付款金額驗證中註冊的 API(應用程式伺服器)請求驗證金鑰。此時,以回調格式傳遞商品 ID、價格資訊、優惠券代碼等。
- 在 Hive 控制台中註冊付款金額驗證 API:請參閱下方前提條件
- 應用程式伺服器:驗證接收到的商品 ID 和價格資訊等後,返回用於付款驗證的驗證金鑰(
gameserver_price_verify_key)作為回應。 - Hive 伺服器:將從應用程式伺服器收到的驗證金鑰與商品 ID 和價格資訊等一起傳遞給計費伺服器以請求付款。
- 應用程式伺服器:確認計費伺服器付款完成結果傳來的驗證金鑰、商品 ID、價格資訊等。只有當收到的驗證金鑰與第 3 步中驗證並發放的值一致時,才判定付款有效。只有驗證成功時才發放商品。
- 設有帳戶購買限制或購買數量限制的商品:請參閱網店購買限制驗證
前提條件¶
要正常呼叫'付款金額驗證' API,請首先在 Hive 控制台中註冊用於發放驗證金鑰的端點 URL。Hive 伺服器可以透過向該 URL 傳遞商品 ID、價格資訊、優惠券代碼等來請求驗證金鑰。
在 Hive 控制台 > 社群 & 網店 > 網店 > 網店設定 > 付款金額驗證 中,根據付款有效性驗證設定註冊 API 端點(回調 URL)。
- 回調 URL 格式可以由遊戲公司自由設定
- 其他 API 規範遵循下面的 API 請求配置和 API 回應配置項目
API 呼叫(Hive 伺服器 → 應用程式伺服器)¶
這解釋了從 Hive 伺服器向應用程式伺服器呼叫'付款金額驗證' API 的方式。
Request info¶
- 端點:在 Hive 控制台 > 社群 & 網店 > 網店 > 網店設定 > 付款金額驗證 中設定的端點(回調 URL)
- HTTP 方法:POST
Request header¶
| API 資訊 | 描述 |
|---|---|
| Response Format | JSON |
| Content-type | application/json |
Request body¶
| 名稱 | 類型 | 必需(必需:O,可選:X) | 描述 |
|---|---|---|---|
| game_index | Integer | O | 遊戲唯一識別符 |
| cs_code | String | O | 購買使用者的 PlayerID |
| language | String | O | 語言代碼(例如:ko、en、ja) |
| market_pid | String | O | 在Hive 控制台網店 > 商品管理中註冊的商品 ID |
| quantity | Integer | O | 購買數量 |
| original_price | Integer | O | 原始商品金額 |
| sale_price | Integer | O | 折扣應用後金額 |
| coupon_price | Integer | O | 優惠券折扣金額 |
| final_price | Integer | O | 優惠券和折扣應用後的最終付款金額 |
| discount_coupon_code | String | O | 應用的折扣優惠券代碼(未使用優惠券時不傳遞) |
Request body sample¶
{
"game_index": 1001,
"cs_code": "20000010000",
"language": "ko",
"market_pid": "item01",
"quantity": 1,
"original_price": 10000,
"sale_price": 8000,
"coupon_price": 1000,
"final_price": 7000,
"discount_coupon_code": "SUMMER2025"
}
API 回應(應用程式伺服器 → Hive 伺服器)¶
這解釋了作為呼叫'付款金額驗證' API 的結果,從應用程式伺服器發送到 Hive 伺服器的回應資訊。
Response body¶
- 資料類型:JSON
-
參數
名稱 類型 描述 code Integer 結果代碼(100:成功) gameserver_price_verify_key String 用於付款驗證的驗證金鑰(成功時必須返回)
Response code¶
| HTTP 狀態代碼 | 代碼 | 訊息 | 描述 |
|---|---|---|---|
| 200 | 100 | Success. | 成功 |
- 成功必須以 100 傳遞。
- 成功時,回應中必須包含
gameserver_price_verify_key。