ウェブフックの設定

ウェブフックは、パラメータとそれに対応する値で構成されるプログラムコードです。特定のイベントが発生すると、パラメータの値が更新されたHTTPリクエストがアプリケーションに送信されます。これは通常、JSON形式のPOSTリクエストです。

イベントの例：ユーザーによるアイテムカタログの操作、決済、注文のキャンセル。

ウェブフックのリスト

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

決済 — 注文が支払われたときに送信され、決済データおよび取引の詳細が含まれます。
ご注文の決済が完了した — 決済ウェブフックが正常に処理されたときに送信され、購入したアイテムに関する情報とトランザクションIDが含まれます。ウェブフックのデータを使用して、ユーザーにアイテムを追加します。
返金 — 注文がキャンセルされたときに送信され、キャンセルされた決済データと取引の詳細が含まれます。
注文キャンセル — 返金ウェブフックが正常に処理されたときに送信され、購入したアイテムに関する情報とキャンセルされたトランザクションのIDが含まれています。購入した商品を削除するには、ウェブフックのデータを使用します。
ユーザー検証 — ユーザーがゲームに登録されていることを確認するために、決済プロセスのさまざまな段階で送信されます。

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

external ID（システム上のトランザクションID）を使用していて、エクソーラ側でトランザクションIDと関連付けたり、ユーザー検証時に追加パラメータを渡したい場合は、トランザクションのIDをリンクするウェブフックを実装します。

実際に支払いを受けるには、「決済」、「ご注文の決済が完了した」と「ユーザー検証」ウェブフックを実装し、ライセンス契約に署名するだけで済みます。

ウェブフックを使う代わりに、PlayFab統合を使って決済情報や注文キャンセル情報を受け取ることができます。

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

ウェブフックをテストするには、webhook.siteのような専用ウェブサイトを選択します。

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

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

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

署名を生成するには：

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

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

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

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

決済ウェブフックの応答が受信されなかった場合、または5xxコードを含む応答を受け取った場合は、ウェブフックも時間間隔を空けて再送信されます。12時間以内に最大12回の試行が行われます。

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

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

ウェブフックの完全なリストとメカニズム、およびその処理の詳細な事例については、ウェブフックドキュメンテーションに記載されています。

進捗状況

最終更新日: 2023年10月10日

誤字脱字などのテキストエラーを見つけましたか？テキストを選択し、Ctrl+Enterを押します。