決済金額検証 API
「決済金額検証」APIは、ユーザーがウェブショップの商品割引やクーポンを適用して変更された金額の商品を購入しようとする際に、ゲームサーバーから発行された検証キーを使用して割引された決済金額を検証することをサポートします。有効な検証キーで決済が行われると、最終的にゲームサーバーから商品を支給できます。
動作フロー¶
「決済金額検証」API呼び出しから最終商品支給までの全体的な処理順序およびシステム間の処理過程を説明します。
Hiveウェブショップサーバーとゲームサーバー間の動作およびデータフローは以下の通りです:
- ユーザーアクション:Hiveウェブショップで変更された金額の商品を購入する際、「決済金額検証」APIが呼び出されます。
- Hiveウェブショップサーバー:Hiveコンソールに登録された検証キー発行対象URL(ゲームサーバー)に検証キーを要求します。この時、商品PID、価格情報、クーポンコードなどをコールバック形式で配信します。
- Hiveコンソールに検証キー発行対象URLを登録するプロセスについては、以下の前提条件を参照してください。
- ゲームサーバー:受け取った価格情報を検証した後、決済検証に使用される検証キー(
gameserver_price_verify_key)をレスポンスとして返します。 - Hiveウェブショップサーバー:ゲームサーバーから受領した検証キーと共に商品PIDおよび価格情報などを課金サーバーを通じて再びゲームサーバーに配信することで決済金額検証を実行します。
- ゲームサーバー:課金サーバーで決済完了が行われると、受け取った検証キーの有効性を確認した後、最終商品を支給します。
前提条件¶
「決済金額検証」APIが正常に呼び出されるには、まずゲーム会社が検証キーを発行する対象であるエンドポイントURLをHiveコンソールに登録する必要があります。Hiveウェブショップサーバーでは、そのURLに商品PID、価格情報、クーポンコードなどを配信して検証キーを要求できます。
Hiveコンソール > コミュニティ&ウェブショップ > ウェブショップ > ウェブショップ設定 > 決済金額検証でAPIエンドポイント(コールバックURL)を登録します。
- コールバックURL形式はゲーム会社が自由に設定可能
- その他のAPI仕様は下記のAPIリクエスト構成およびAPIレスポンス構成項目に従う
API呼び出し(HiveウェブショップサーバーからゲームサーバーVer)¶
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 | 商品固有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を必ず含めて応答する必要があります。