ウェブフックの設定

ウェブフックは、システムで発生したイベントの通知です。特定のイベントが発生すると、エクソーラはイベントデータを送信するHTTPリクエストをアプリケーションに送信します。これは通常JSON形式のPOSTリクエストです。

イベント例：

• アイテムカタログとのユーザーインタラクション
• 注文の支払いまたはキャンセル

ウェブフックのリスト

組み込みのウェブフックを受信する新しいオプションに切り替えるには、カスタマーサクセスマネージャーに連絡するか、csm@xsolla.comに電子メールを送信してください。

インゲームストアと決済管理を完全に操作するには、メインのウェブフックの処理を実装する必要があります：

• 組み込みのウェブフックを受信した場合
• 個別のウェブフックを受け取った場合

ウェブフック名	説明
ユーザー検証 > ユーザー検証（user_validation）	ユーザーがゲームに登録されていることを確認するため、支払いプロセスのさまざまな段階で送信されます。
ゲームサービス > 組み込みのウェブフック > 注文支払い完了（order_paid）	支払いデータ、トランザクションの詳細、購入した商品に関する情報が含まれます。ウェブフックのデータを使用して、ユーザーにアイテムを追加します。
ゲームサービス > 組み込みのウェブフック > 注文のキャンセル（order_canceled）	キャンセルされた支払いのデータ、取引の詳細、購入した商品に関する情報が含まれます。ウェブフックのデータを使用して、購入したアイテムを削除します。

以下のスキームは、集約ウェブフックを使用してアイテムを購入して返品するプロセスを示しています。

ウェブフック名	説明
ユーザー検証 > ユーザー検証（user_validation）	ユーザーがゲームに登録されていることを確認するため、支払いプロセスのさまざまな段階で送信されます。
決済 > 支払い（payment）	支払いデータと取引の詳細が含まれます。
ゲームサービス > 個別のウェブフック > 注文支払い完了（order_paid）	購入したアイテムに関する情報とトランザクションIDが含まれています。ウェブフックのデータを使用して、ユーザーにアイテムを追加します。
決済 > 返金（refund）	支払いデータと取引の詳細が含まれます。
ゲームサービス > 個別のウェブフック > 注文のキャンセル（order_canceled）	購入したアイテムに関する情報とキャンセルされたトランザクションのIDが含まれています。購入した商品を削除するには、ウェブフックのデータを使用します。

以下のスキームは、別のウェブフックを使用してアイテムを購入して返品するプロセスを示しています。

アイテムカタログのパーソナライゼーションがアプリケーション側で実装されている場合は、パートナー側でカタログのパーソナライゼーションの処理を設定します。

アドミンページでのウェブフックのセットアップ

ウェブフックの受信を有効にするには：

1. アドミンページでプロジェクトを開きます。
2. サイドメニューの「プロジェクト設定」をクリックし、「ウェブフック」タブに移動します。
3. 「ウェブフックサーバー」フィールドに、https://example.com形式でウェブフックを受信したいサーバーのURLを指定します。ウェブフックをテストするツールで見つけたURLを指定することもできます。

4. プロジェクトのウェブフックに署名するための秘密鍵は、デフォルトで生成されます。新しい秘密鍵を生成したい場合は、更新アイコンをクリックします。
5. 「ウェブフックを有効にする」をクリックします。

「ウェブフックサーバー」フィールドにURLを保存すると、「詳細設定」セクションが表示され、ウェブフックで詳細情報を受信するための権限を与えることができます。これを行うには、必要なトグルを「アクティブ」に設定します。各権限の行には、設定に影響を受けるウェブフックのリストが表示されます。

1. アドミンページでプロジェクトを開きます。
2. サイドメニューで「プロジェクト設定」をクリックし、「ウェブフック」タブに移動します。
3. 「ウェブフックを無効にする」をクリックします。

アドミンページでのウェブフックをテストする

ウェブフックが正常にセットアップされると、ウェブフックセットアップブロックの下にウェブフックテストブロックが表示されます。

アドミンページのテストセクションは、ウェブフック受信オプションによって異なります。

組み込みのウェブフックを使用したシナリオのテストプロセスを以下に説明します。

「決済ソリューションとストア」タブで、以下のウェブフックをテストできます：

• ユーザー検証（user_validation）
• 注文支払い完了（order_paid）
• 注文のキャンセル（order_canceled）

1. ウェブフックテストセクションでは、「決済ソリューションとストア」タブに移動します。
2. ドロップダウンメニューで、アイテムのタイプを選択します。選択したタイプのアイテムがアドミンページで設定されていない場合、次のことをクリックします：
   • 接続する – このタイプのアイテムを持つモジュールが接続されていない場合
   • 構成する – 以前にモジュールを接続したが、セットアップを完了していない場合
   ボタンをクリックすると、選択したアイテムのタイプに対応するアドミンページのセクションにリダイレクトされます。アイテムを作成したら、ウェブフックテストセクションに戻り、次のステップに進みます。
3. 必要なフィールドを入力します：
   1. ドロップダウンリストからアイテムのSKUを選択し、金額を指定します。「+」をクリックして新しい行に追加することで、同じタイプのアイテムを複数選択することができます。
   2. ユーザーID — テストの際には、自由にアルファベットと数字の組み合わせを使用できます。
   3. パブリックユーザーID — メールアドレスやニックネームなど、ユーザーが知っているID。このフィールドは「ペイステーション > 設定」セクションでプロジェクトでパブリックユーザーIDが有効になっている場合に表示されます。
   4. 「エクソーラ注文ID」フィールドに任意の値を入力します。
   5. エクソーラインボイスID — エクソーラ側のトランザクションID。テストの際には、任意の数値を使用できます。
   6. インボイスID — ゲーム側のトランザクションID。テストの際には、自由にアルファベットと数字の組み合わせを使用できます。これは決済を成功させるための必須パラメータではありませんが、エクソーラ側のトランザクションIDとあなた側のトランザクションIDをリンクさせるために渡すことができます。
   7. 金額 — 支払金額。テスト時には、任意の数値を使用できます。
   8. 通貨 — ドロップダウンリストから通貨を選択します。
4. 「テストウェブフックをテスト」をクリックします。

各ウェブフックについて、成功したシナリオとエラーが発生したシナリオの両方を処理するように設定する必要があります。

ウェブフックリスナー

ウェブフックリスナーは、指定されたURLアドレスで受信したウェブフックを受信し、署名を生成し、エクソーラウェブフックサーバーに応答を送信できるようにするプログラムコードです。

署名の生成

ウェブフックを受信する場合、データ伝送のセキュリティを確保する必要があります。そのためには、ウェブフックのデータから署名を生成し、それがHTTPリクエストヘッダで送信された署名と一致することを検証する必要があります。

署名を生成するには：

1. リクエスト本文のJSONとプロジェクトの秘密鍵を連結します。
2. 最初のステップで取得した文字列にSHA-1暗号化ハッシュ関数を適用します。

ウェブフックへの応答の送信

ウェブフックの受信を確認するには、サーバーが以下のことを返す必要があります：

• 成功した応答の場合は200、201、または204 HTTPコード。
• 指定されたユーザーが見つからなかったり、無効な署名が渡された場合、問題に関する説明が記載された400 HTTPコードが表示されます。

ウェブフックハンドラーは、サーバーに一時的な問題が発生した場合に5xxコードを返すこともあります。

エクソーラサーバーが「注文支払い完了」と「注文のキャンセル」のウェブフックで応答を受信しなかった場合、または5xxコードの応答を受信した場合、以下のスケジュールでウェブフックを再送信します：

• 5分間隔で2回再試行
• 15分間隔で7回再試行
• 60分間隔で10回再試行

ウェブフックの送信は、最初の試行から12時間以内に最大20回まで試行されます。

エクソーラサーバーが決済ウェブフックまたは返金ウェブフックに対して応答を受信しない場合、または応答を受信した5xxコード、ウェブフックも時間間隔が長くなって再送される12時間以内に最大12回の試行が行われます。

エクソーラサーバーがユーザー検証ウェブフックに対する応答が受信されなかった場合、400または5xxのコードを含む応答が受信された場合、ユーザー検証ウェブフックは再送信されません。

この場合、ユーザーにはエラーが表示され、「決済」と「注文支払い完了」のウェブフックは送信されません。

ウェブフックにおけるアイテム情報の構成

注文支払い完了と注文のキャンセルのウェブフックで送信されるアイテムデータは、items配列を通じて設定できます。

追加パラメータの包含の有効化

以下の情報を示す追加パラメータの包含を有効にします：

• アイテムが無料かどう（is_free）
• アイテムがボーナスかどうか（is_bonus）
• アイテムがバンドルの一部かどうか（is_bundle_content）

これらのパラメータを受け取るには、ウェブフック設定に関する情報を更新APIコールを使用してウェブフックのバージョンを2に変更してください。バージョン1（デフォルト）では、これらのパラメータは提供されていません。

追加パラメータを含むアイテム配列の例：

 1
 2"items": [
 3      {
 4        "sku": "com.xsolla.item_new_1",
 5        "type": "bundle",
 6        "is_pre_order": false,
 7        "is_free": false,
 8        "is_bonus": false,
 9        "Is_bundle_content": false,
10        "quantity": 1,
11        "amount": "1000",
12        "promotions": []
13      },
14      {
15        "sku": "com.xsolla.gold_1",
16        "type": "virtual_currency",
17        "is_pre_order": false,
18        "is_free": false,
19        "is_bonus": false,
20        "is_bundle_content": true,
21        "quantity": 1500,
22        "amount": "[null]",
23        "promotions": []
24      }
25 ],

バンドルコンテンツ包含の無効化

デフォルトでは、ウェブフックはバンドルのすべてのアイテムを個々のアイテムのリストとして含めます。ウェブフックのコンテンツをリスト化せずに、バンドルそのもののみを含めるように設定することができます。

この場合、バンドルに含まれるアイテムはitems配列には含まれません。上記の配列で示されているように、バンドルの一部であるSKUcom.xsolla.gold_1のアイテムは除外されます。

バンドルコンテンツが無効になっている場合のアイテム配列の例：

 1
 2"items": [
 3      {
 4        "sku": "com.xsolla.item_new_1",
 5        "type": "bundle",
 6        "is_pre_order": false,
 7        "is_free": false,
 8        "is_bonus": false,
 9        "Is_bundle_content": false,
10        "quantity": 1,
11        "amount": "1000",
12        "promotions": []
13      }
14 ],

バンドルコンテンツ包含を無効にするには、カスタマーサクセスマネージャーまでお問い合わせるか、csm@xsolla.comに電子メールを送信してください。