注文状況追跡のセットアップ
ユーザーにアイテムを付与するには、支払いが成功したことを確認する必要があります。
注文状況を追跡する方法を選択します:
エクソーラデータにアクセスするために、プロジェクトに最も適した方法を選択してください:
サーバーがない場合、またはクライアント側で購入処理のロジックを実装している場合は、次のメソッドを使用できます:
WebSocket APIを使用してクライアント側で注文状況の取得
このソリューションでは、websocketを使用して、注文の詳細情報を取得せずに注文状況を取得します。このメソッドが推奨されます:クライアント(例えば、ウェブサイトやモバイルアプリケーション)とエクソーラサーバー間には1つの接続しか作成されないため、クライアントやサーバーへの追加の負荷は発生しません。
以下の手順を完了してください:
- エクソーラのwebsocketサーバーとクライアントが注文状況メッセージを識別できるようにするために、接続を作成します:
- javascript
const client = new Centrifuge(
connectionURL,
{
data: {
user_external_id: user_external_id,
auth: auth,
project_id: project_id
}
}
)
connectionURL - wss://ws-store.xsolla.com/connection/websocket
auth - user JWT token
- 注文状況に関する新しいメッセージを受信するには、
client.on
関数を使用してイベントを登録します:
- javascript
client.on('publication', (ctx) => {
//handle the status
});
- 実際の接続確立をトリガーします:
- javascript
client.connect()
- 注文状況の変更履歴を受信するには、API履歴メソッドに接続してください。
- javascript
client.on('subscribed', function (ctx) {
client.history(ctx.channel, { limit: -1, since: { offset: 0 }, reverse: false }).then(function (resp) {
resp.publications.forEach((ctx) => {
/handle the status
});
}, function (err) {
//handle the status
});
});
メッセージ本文の例:
- javascript
{
order_id: 59614241,
status: 'new'
}
以下の注文状況があります:
New
— オーダーは作成されたが未払いであるPaid
— 注文は支払われるDone
— 注文が配信されたこと(すべての領収書の送付、エクソーラ側での配信、外部プラットフォームでの配信、など)Canceled
— 注文がキャンセルされ、代金がユーザーに返金される
ウェブソケット経由の応答に必要な時間は5分です。その後、またはウェブソケットに問題がある場合は、ショートポーリングを使用することが推奨されます。
ショートポーリング
ステータスを切り替えた後のオーダーのアイテムの詳細情報を取得するには、注文を取得するAPIを呼び出します。
XsollaCatalog.Purchase
メソッドは、注文状況を追跡するためのいくつかのメソッドをカプセル化しています。追跡メカニズムは、Unity向けエンタープライズレベルSDKのドキュメンテーションに詳しく記載されています。
さらに、購入メソッドのonSuccess
コールバック関数に渡される注文状況と内容の処理を実装することができます。
SDKを使用する場合、以下の方法で注文状況を追跡することができます:
注文ステータスの変更をサブスクライブする
注文状況の変更をサブスクライブするには、ストアライブラリのgetOrderStatus
SDKメソッドを使用し、以下のパラメータをメソッドに渡します:
listener
—OrderStatusListener
タイプのリスナーオブジェクト。orderId
— ショッピングカートでの購入、ワンクリック購入、または仮想通貨での購入で受け取った注文IDをパラメータとします。
XStore.getOrderStatusメソッドの呼び出し例:
- kotlin
XStore.getOrderStatus(object : OrderStatusListener() {
override fun onStatusUpdate(status: OrderResponse.Status) {
if(status == OrderResponse.Status.DONE) {
Log.d("MainActivity", "Success")
}
}
override fun onFailure() {
Log.d("MainActivity", "Failure")
}
}, orderId)
決済UIを開く際にXStore.getOrderStatus
メソッドを呼び出すことをお勧めします。
購入メソッドは、注文ステータスを追跡するためのいくつかのメソッドをカプセル化します。追跡は、以下のアルゴリズムに従って行われます:
- ウェブソケット接続が確立されます。
- ウェブソケット接続が正常に確立され、注文ステータスが
done
またはcancel
に変更された場合、トラッキングは停止します。ウェブソケット接続が失敗した場合、またはレスポンスに不正なデータが含まれている場合、注文ステータスはショートポーリングを使用して追跡されます。 - 注文ステータスの追跡はショートポーリングで継続されます。シンプルなHTTPオーダーステータスリクエストが3秒に1回送信されます。注文ステータスが
done
またはcancel
に変更された場合、追跡は停止します。
注文状況をリクエストする
支払いトランザクションの現在のステータスを要求するには、ストアライブラリのgetOrder
メソッドを呼び出し、次のパラメータを渡します:
orderId
— 商品を購入する時に受け取った注文ID。callback
— 注文情報を正常に取得するコールバック。コールバックを実装する場合は、GetStatusCallback
インターフェイスを使用し、onSuccess
とonError
メソッドを実装します。callback
— 注文情報を正常に取得するコールバック。コールバックを実装する場合は、GetStatusCallback
インターフェイスを使用し、onSuccess
とonError
メソッドを実装します。
注文状況の情報は、onSuccess
メソッドにInvoicesDataResponse
タイプのオブジェクトで渡されます。このオブジェクトは、InvoiceData
オブジェクトの配列を含みます。各InvoiceData
オブジェクトは、注文処理の特定の段階に対応し、その段階のステータスを含んでいます。
たとえば、ユーザーが注文時に最初に無効なデータを入力した場合、ステータスがInvoicesDataResponse.CANCELED
のオブジェクトがInvoiceData
リストに表示されます。その後、ユーザーがデータを修正し、注文の支払いが正常に行われると、新しいInvoiceData
オブジェクトが配列に表示され、ステータスはInvoicesDataResponse.Status.DONE
になります。
最終の支払いステータス(InvoicesDataResponse.Status.DONE
またはInvoicesDataResponse.Status.ERROR
)を受信した場合、ステータス追跡は停止します。
例:
- kotlin
XPayments.getStatus(<token>, <isSandbox>, object : GetStatusCallback {
override fun onSuccess(data: InvoicesDataResponse?) {
Log.d(TAG, "onSuccess is fired. Result data = $data")
}
override fun onError(throwable: Throwable?, errorMessage: String?) {
Log.d(TAG, "onError is fired. ErrorMessage = $errorMessage")
}
})
CheckPendingOrder
SDKメソッドを使用して注文状況を追跡することができます。メソッドに以下のパラメータを渡します:
AccessToken
— 商品を購入する時に受け取った支払いトークン。OrderId
— 商品を購入する時に受け取った注文ID。SuccessCallback
— 決済成功時のコールバック。ErrorCallback
— リクエストエラー時のコールバック。bIsUserInvolvedToPayment
— ユーザーが支払いプロセスに関与しているかどうか。実際通貨で購入する場合はtrue
を、無料アイテム購入と仮想通貨で購入する場合はfalse
を渡します。
追跡メカニズムは、Unreal Engine向けエンタープライズレベルSDKのドキュメンテーションに詳しく記載されています。
注文状況と内容をリクエストするには、CheckOrder
SDKメソッドを呼び出し、次のパラメータを渡します:
作成された注文のステータスを追跡して検証するには、アプリケーションのサーバー側でウェブフック処理を構成する必要があります。
インゲームストアを完全に操作するには、主要なウェブフックの処理を実装する必要があります:
ウェブフック | 通知タイプ | 説明 |
---|---|---|
ユーザー検証 | user_validation | ユーザーがゲームに登録されていることを確認するため、決済プロセスのさまざまな段階で送信されます。 |
支払い | payment | 注文が支払われたときに送信され、支払いデータおよび取引詳細が含まれます。 |
ご注文の決済が完了した | order_paid | 支払いウェブフックが正常に処理されたときに送信され、購入したアイテムに関する情報とトランザクションIDが含まれています。ウェブフックのデータを使用して、ユーザーにアイテムを追加します。 |
返金 | refund | 注文がキャンセルされたときに送信され、キャンセルされた決済データと取引の詳細が含まれます。 |
注文キャンセル | order_canceled | 返金ウェブフックが正常に処理されたときに送信され、購入したアイテムに関する情報とキャンセルされたトランザクションのIDが含まれています。購入した商品を削除するには、ウェブフックのデータを使用します。 |
ウェブフックの完全なリストと、ウェブフックの操作に関する一般情報については、ウェブフックのドキュメンテーションを参照してください。
ウェブフックの送信を設定する
エクソーラ側でウェブフックを構成するには:
- アドミンページでプロジェクトを開きます。
- サイドメニューで「プロジェクト設定」をクリックし、「ウェブフック」セクションに移動します。
- 「ウェブフックURL」フィールドに、エクソーラがウェブフックを送信する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
のコードを含む応答が受信された場合、ユーザー検証ウェブフックは再送信されません。
この場合、ユーザーにはエラーが表示され、「決済」と「ご注文の決済が完了した」のウェブフックは送信されません。
誤字脱字などのテキストエラーを見つけましたか? テキストを選択し、Ctrl+Enterを押します。