決済トークンの取得方法

決済UIを開くには、トークンを取得する必要があります。トークンとは、ゲームとユーザーに関する暗号化されたデータを含む文字列です。トークンを取得してユーザーを識別し、購入を許可するように実装する必要があります。

決済トークンを取得するには:

  1. ユーザー認証トークンを取得します
  2. 注文を作成します

ユーザー認証トークンを取得する

トークンの有効期限は、最後にエクソーラAPIを呼び出してから14時間後です。有効期限が切れた後に新しいトークンを受け取るロジックを実装してください。ユーザーがアプリケーションに再ログインする必要がないように、バックグラウンドで新しいトークンを取得することをお勧めします。

アプリケーションのバックエンドで、ユーザー認証トークンの取得を実装します。これを行うには、基本的なHTTP認証を含むHTTP POSTリクエストを使用し、リクエスト本文で必要なパラメータを渡します。

APIリファレンス
パラメータの全リストを参照してください。

基本HTTP認証

エクソーラAPIは基本アクセス認証を採用しています。APIに対する全リクエストは、Authorization: Basic <your_authorization_basic_key>ヘッダーを含む必要があります。<your_authorization_basic_key>マーチャントID:APIキーのペアで、Base64の基準に従ってエンコードしています。アドミンページに移動して、次のパラメータを見つけます:

  • マーチャントIDは以下の場所で表示されます:
    • プロジェクト設定 > ウェブフックセクション。
    • 会社設定 > 会社セクション。
    • アドミンページページのブラウザーアドレスバーのURL。URLは以下の形式があります:`https://publisher.xsolla.com/​マーチャントID/アドミンページセクション`。

  • APIキーは、作成時に一度だけアドミンページに表示され、お客様側で保存する必要があります。次のセクションで新しいキーを作成できます:
    • 会社設定 > APIキー
    • プロジェクト設定 > APIキー
注意

APIキーの操作については、APIリファレンスを参照してください。

キーに関する推奨事項:

  • 生成されたAPIキーは、お客様側で保存してください。APIキーは、アドミンページで作成時に一度だけ表示することができます。
  • APIキーは秘密にしておいてください。APIキーは、お客様の個人アカウントとアドミンページのプロジェクトへのアクセスを提供します。
  • APIキーはサーバーに保存する必要があり、決してバイナリやフロントエンドに保存してはいけません。

リクエスト本文

リクエスト本文に、以下の必須パラメータを渡します:

パラメータ種類説明文
user.id
stringお使いのシステムの一意のユーザーID。
user.email
string購入時の領収書を送信するためのユーザーメールアドレスです。このパラメータを渡さなかった場合、決済画面にメールアドレス入力のための必須フィールドが表示されます。
settings.project_id
integerゲーマーのXsolla ID。この情報は、アドミンページのプロジェクトセクションで確認することができます。

ユーザーエクスペリエンスを向上させるために、以下のパラメータを渡すこともできます:

パラメータ種類説明文
user.name
stringレシートに表示されるユーザースクリーンネーム。
settings.currency
string優先決済通貨。
settings.language
stringインターフェース言語。
ユーザー認証トークンを取得するためのリクエスト例
Copy
Full screen
Small screen
    curl -i -X POST \
      -u 2340:ZHgbSDVP6LtAJVWu \
      https://api.xsolla.com/merchant/v2/merchants/<merchant_id>/token \
      -H 'Content-Type: application/json' \
      -d '{
        "settings": {
          "currency": "USD",
          "language": "en",
          "project_id": <project_id>
          }
        },
        "user": {
          "email": {
            "value": "<user_email>"
          },
          "id": {
            "value": "<user_id>"
          },
          "name": {
            "value": "<user_name>"
          }
        }
      }'
    

    応答で受け取ったユーザー認証トークンの例

    Copy
    Full screen
    Small screen
      {
          "token": "1230OWrp0KF6uqvmN8jWuzLyoXMzxTyK_lc_en"
      }
      

      決済トークンを取得する

      決済トークンを取得するには、注文を作成します。 注文とは、ユーザーがストアで購入したいアイテムです。注文が決済されると、ユーザーはアイテムを受け取ります。決済フローをテストするには、指定されたアイテムで注文を作成するAPIコールを使用して注文を作成します:

      1. APIドキュメンテーションウェブサイトでテストを実行する場合は、Try itをクリックしてリクエストを作成するためのインターフェイスを開きます。
      2. SecurityブロックのBearer Tokenフィールドに、認証手続きの通過時に取得したトークンを入力します。
      3. Bodyブロックには、注文の詳細(数量や品目数量など)を渡します。サンドボックスモードにアクセスするには、"sandbox": trueを渡します。
      4. Parametersブロックで、以下を渡します:
        • project_idアドミンページで確認できるプロジェクトID。
        • item_sku — アイテムSKU。
      お知らせ
      エクソーラAPIを呼び出すには、ゲームエンジンやプラットフォームに対応したSDKの既成のメソッドを利用することができます。

      レスポンスでは、今後の作業に必要なデータを受け取ります:

      • token — 決済トークン

      この記事は役に立ちましたか?
      ありがとうございます!
      改善できることはありますか? メッセージ
      申し訳ありません
      この記事が参考にならなかった理由を説明してください。 メッセージ
      ご意見ありがとうございました!
      あなたのメッセージを確認し、体験を向上させるために利用させていただきます。
      このページを評価する
      このページを評価する
      改善できることはありますか?

      答えたくない

      ご意見ありがとうございました!
      最終更新日: 2024年3月26日

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

      問題を報告する
      当社は常にコンテンツを見直しています。お客様のご意見は改善に役立ちます。
      フォローアップ用のメールをご提供してください
      ご意見ありがとうございました!