ウェブフックをセットアップする

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

イベント例：

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

ウェブフックのリスト

ゲームキーの販売には、ユーザー検証やアイテムのクレジットは必要ありません。支払いや注文のキャンセルなどのイベントに関する情報を受け取りたい場合は、ウェブフックを接続できます。

ウェブフックを接続する場合は、受信した必要なウェブフックをすべて処理することが重要です。

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

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

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

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

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

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

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

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

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

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

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

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

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

組み込みのウェブフックを使用したシナリオのテストプロセスを以下に説明します。 「決済とストア」タブで、以下のウェブフックをテストできます：

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

テストするには：

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

ユーザー検証、指定されたデータを含む「注文支払い成功」と「注文のキャンセル」のウェブフックが指定されたURLに送信されます。各ウェブフックタイプのテスト結果は、「テスト」ボタンの下に表示されます。 プロジェクトでパブリックユーザーIDが有効になっている場合、ユーザー検索チェックの結果も表示されます。

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

ウェブフックリスナー

ウェブフックリスナーは、指定された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のコードを含む応答が受信された場合、ユーザー検証ウェブフックは再送信されません。

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

最終更新日: 2025年1月23日