注文状況追跡のセットアップ
ユーザーにアイテムを付与するには、支払いが成功したことを確認する必要があります。
注文状況を追跡する方法を選択します:
エクソーラデータにアクセスするために、プロジェクトに最も適した方法を選択してください:
サーバーがない場合、またはクライアント側で購入処理のロジックを実装している場合は、次のメソッドを使用できます:
WebSocket APIを使用してクライアント側で注文状況の取得
このソリューションでは、websocketを使用して、注文の詳細情報を取得せずに注文状況を取得します。このメソッドが推奨されます:クライアント(例えば、ウェブサイトやモバイルアプリケーション)とエクソーラサーバー間には1つの接続しか作成されないため、クライアントやサーバーへの追加の負荷は発生しません。
以下の手順を完了してください:
- エクソーラのwebsocketサーバーとクライアントが注文状況メッセージを識別できるようにするために、接続を作成します:
- javascript
1const client = new Centrifuge(
2connectionURL,
3{
4data: {
5 user_external_id: user_external_id,
6 auth: auth,
7 project_id: project_id
8}
9}
10)
11connectionURL - wss://ws-store.xsolla.com/connection/websocket
12auth - user JWT token
- 注文状況に関する新しいメッセージを受信するには、
client.on
関数を使用してイベントを登録します:
- javascript
1client.on('publication', (ctx) => {
2 //handle the status
3});
- 実際の接続確立をトリガーします:
- javascript
1client.connect()
- 注文状況の変更履歴を受信するには、API履歴メソッドに接続してください。
- javascript
1client.on('subscribed', function (ctx) {
2 client.history(ctx.channel, { limit: -1, since: { offset: 0 }, reverse: false }).then(function (resp) {
3resp.publications.forEach((ctx) => {
4 /handle the status
5});
6
7 }, function (err) {
8 //handle the status
9 });
10});
メッセージ本文の例:
- javascript
1{
2order_id: 59614241,
3status: 'new'
4}
以下の注文状況があります:
New
— オーダーは作成されたが未払いであるPaid
— 注文は支払われるDone
— 注文が配信されたこと(すべての領収書の送付、エクソーラ側での配信、外部プラットフォームでの配信、など)Canceled
— 注文がキャンセルされ、代金がユーザーに返金される
Websocketの使用に関する推奨事項:
- Websocket経由の応答待ち時間は最大5分です。
- 決済UIを開くときに接続を確立する必要があります。
- 最終的な注文ステータスが
Canceled
またはDone
になったら、接続を中止する必要があります。 - WebSocketの寿命が切れた場合、または接続に問題がある場合は、ショートポーリングを使用します。
ショートポーリング
ステータスを切り替えた後のオーダーのアイテムの詳細情報を取得するには、注文を取得するAPIを呼び出します。
エクソーライベントAPI
概要
エクソーライベントAPIを使用すると、GetUpdatesサービスを利用して、サーバー上でウェブフックを使用せずに、アプリケーションクライアントから直接支払い情報を受信および処理できます。支払いウェブフックを処理するために独自のサーバーをセットアップおよび維持する必要性をなくし、統合を迅速化および簡素化したい場合は、この統合オプションを使用してください。
ゲームとエクソーラの間のインタラクション:
設定方法
APIを介してエクソーラからイベントを受信するには:
- プロジェクトのパブリッシャーアカウントで、プロジェクト設定 > ウェブフックセクションに移動します。
- 「APIを使用する」をクリックします。設定は自動的に保存されます。
- アプリケーションクライアントから、支払い情報を取得するために
https://getupdate.xsolla.com/events
にリクエストを送信してください。詳細については、APIリファレンスを参照してください。応答として、決済ウェブフックと同じ形式で支払いデータを受け取ります。 - 支払いが成功した場合、ユーザーに購入を許可します。
APIリファレンス
ユーザーの未処理イベントリストを取得する
- http
1GET https://getupdate.xsolla.com/events
セキュリティ:BearerユーザーJWTトークン
レスポンス例:
- json
1{
2 "events": [
3 {
4 "id": 49, // event_id
5 "status": 0,
6 "created_at": "2025-04-03T21:21:27Z",
7 "data": {
8 "notification_type": "payment",
9 "purchase": {
10 "order": {
11 "id": 000000001,
12 "lineitems": [
13 {
14 "quantity": 1,
15 "sku": "skill"
16 }
17 ]
18 }
19 },
20 ...
21 }
22 }
23 ]
24}
イベントを処理済みとしてマークする
- http
1POST https://getupdate.xsolla.com/events/<event_id>/processed
event_id
は、ユーザーの未処理イベントリストを取得するAPIコールのレスポンスから取得されるevents.id
パラメータです。
セキュリティ:BearerユーザーJWTトークン
XsollaCatalog.Purchase
メソッドは、注文状況を追跡するためのいくつかのメソッドをカプセル化しています。追跡メカニズムは、Unity(PC、ウェブ)向けのSDKに関するドキュメントに詳しく記載されています。
さらに、購入メソッドのonSuccess
コールバック関数に渡される注文状況と内容の処理を実装することができます。
CheckPendingOrder
SDKメソッドを使用して注文状況を追跡することができます。メソッドに以下のパラメータを渡します:
AccessToken
— 商品を購入する時に受け取った支払いトークン。OrderId
— 商品を購入する時に受け取った注文ID。SuccessCallback
— 決済成功時のコールバック。ErrorCallback
— リクエストエラー時のコールバック。bIsUserInvolvedToPayment
— ユーザーが支払いプロセスに関与しているかどうか。実際通貨で購入する場合はtrue
を、無料アイテム購入と仮想通貨で購入する場合はfalse
を渡します。
追跡メカニズムは、Unreal Engine向けエンタープライズレベルSDKに関するドキュメントに詳しく記載されています。
注文状況と内容をリクエストするには、CheckOrder
SDKメソッドを呼び出し、次のパラメータを渡します:
作成された注文のステータスを追跡して検証するには、アプリケーションのサーバー側でウェブフック処理を構成する必要があります。
商品を購入して返品する際には、エクソーラ側に2つのウェブフック受信オプションが設定されています。支払いと取引データを含む情報と購入した商品に関する情報は、別々に取得することも、1つのウェブフックにまとめることもできます。
ウェブフック受信オプションの詳細情報
組み込みのウェブフックで情報を受信します:
2025年1月22日以降にパブリッシャーアカウントに登録した、またはプロジェクトを作成した場合、注文支払い完了(order_paid
)と注文のキャンセル(order_canceled
)のウェブフックですべての情報を受け取ります。この場合、支払い(payment
)と返金(refund
)ウェブフックを処理する必要はありません。
個別のウェブフックで情報を受信します:
2025年1月22日以前にパブリッシャーアカウントに登録した、またはプロジェクトを作成した場合、以下のウェブフックを受け取ります:
- 支払いデータや取引の詳細に関する情報を含む支払い(
payment
)と返金(refund
)ウェブフック。 - 購入したアイテムに関する情報を含む注文支払い完了(
order_paid
)と注文のキャンセル(order_canceled
)ウェブフック。
すべての受信ウェブフックを処理する必要があります。
組み込みのウェブフックを受信する新しいオプションに切り替えるには、カスタマーサクセスマネージャーに連絡するか、csm@xsolla.comに電子メールを送信してください。
インゲームストアと決済管理を完全に操作するには、メインのウェブフックの処理を実装する必要があります:
ウェブフック名 | 説明 |
---|---|
ユーザー検証 > ユーザー検証(user_validation ) | ユーザーがゲームに登録されていることを確認するため、支払いプロセスのさまざまな段階で送信されます。 |
ゲームサービス > 組み込みのウェブフック > 注文支払い完了(order_paid ) | 支払いデータ、トランザクションの詳細、購入した商品に関する情報が含まれます。ウェブフックのデータを使用して、ユーザーにアイテムを追加します。 |
ゲームサービス > 組み込みのウェブフック > 注文のキャンセル(order_canceled ) | キャンセルされた支払いのデータ、取引の詳細、購入した商品に関する情報が含まれます。ウェブフックのデータを使用して、購入したアイテムを削除します。 |
以下のスキームは、集約ウェブフックを使用してアイテムを購入して返品するプロセスを示しています。
ウェブフック名 | 説明 |
---|---|
ユーザー検証 > ユーザー検証(user_validation ) | ユーザーがゲームに登録されていることを確認するため、支払いプロセスのさまざまな段階で送信されます。 |
決済 > 支払い(payment ) | 支払いデータと取引の詳細が含まれます。 |
ゲームサービス > 個別のウェブフック > 注文支払い完了(order_paid ) | 購入したアイテムに関する情報とトランザクションIDが含まれています。ウェブフックのデータを使用して、ユーザーにアイテムを追加します。 |
決済 > 返金(refund ) | 支払いデータと取引の詳細が含まれます。 |
ゲームサービス > 個別のウェブフック > 注文のキャンセル(order_canceled ) | 購入したアイテムに関する情報とキャンセルされたトランザクションのIDが含まれています。購入した商品を削除するには、ウェブフックのデータを使用します。 |
以下のスキームは、別のウェブフックを使用してアイテムを購入して返品するプロセスを示しています。
アイテムカタログのパーソナライゼーションがアプリケーション側で実装されている場合は、パートナー側でカタログのパーソナライゼーションの処理を設定します。
ウェブフックの完全なリストと、ウェブフックの操作に関する一般情報については、ウェブフックに関するドキュメントを参照してください。
ウェブフックの送信を設定する
エクソーラ側でウェブフックを構成するには:
- パブリッシャーアカウント内のプロジェクトで、プロジェクト設定 >ウェブフックセクションに移動します。
- 「ウェブフックサーバー」フィールドに、エクソーラがウェブフックを送信するURLを指定します:
- 「ウェブフックを有効にする」をクリックします。
ウェブフックリスナーを追加する
ウェブフックリスナーは、指定されたURLアドレスで受信したウェブフックを受信し、署名を生成し、エクソーラウェブフックサーバーに応答を送信できるようにするプログラムコードです。
署名の生成
ウェブフックを受信する場合、データ伝送のセキュリティを確保する必要があります。そのためには、ウェブフックのデータから署名を生成し、それがHTTPリクエストヘッダで送信された署名と一致することを検証する必要があります。
署名を生成するには:
- リクエスト本文のJSONとプロジェクトの秘密鍵を連結します。
- 最初のステップで取得した文字列に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
(デフォルト)では、これらのパラメータは提供されていません。
追加パラメータを含むアイテム配列の例:
- json
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
のアイテムは除外されます。
バンドルコンテンツが無効になっている場合のアイテム配列の例:
- json
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に電子メールを送信してください。
誤字脱字などのテキストエラーを見つけましたか? テキストを選択し、Ctrl+Enterを押します。