Catalog API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Catalog APIは、ゲーム内ストアカタログを管理し、購入を処理するためのエンドポイントを提供します。エンドポイントを使用して、仮想アイテム、仮想通貨、ゲームキー、バンドル、カートと決済フロー、アイテムアトリビュート、および外部ソースからのアイテムのインポートを設定できます。
OpenAPI記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/catalog/
https://store.xsolla.com/api/
リクエスト
注文とその支払いトークンを生成します。注文はリクエストボディに渡されたアイテムに基づいて生成されます。
決済UIを新しいウィンドウで開くには、次のリンクを使用します：https://secure.xsolla.com/paystation4/?token={token}。そこで、{token}は受信したトークンです。
テスト目的では、次のURLを使用します：https://sandbox-secure.xsolla.com/paystation4/?token={token}。
通知
この方法の正しい動作には、これら2つのオプションのいずれかが必要です。
選択した通貨は、ペイステーションでの決済方法に使用されます。
user.country.valueパラメータは、注文の通貨を選択するために使用されます。ユーザーの国が不明な場合は、
X-User-IpヘッダーにユーザーのIPを指定することもできます。この方法の正しい動作には、これら2つのオプションのいずれかが必要です。
選択した通貨は、ペイステーションでの決済方法に使用されます。
セキュリティ
basicAuth
キーと値のペアの有効なJSONセットとして表されたカスタムパラメータ。
このフィールドを通じて追加のパラメータを渡すことで、不正対策フィルターを設定することができます。ペイステーションに関するドキュメントンをご覧ください。
例: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
大文字と小文字を区別する一意のコードです。文字と数字が含まれます。
デフォルト "WINTER2021"
例: "WINTER2021"
支払い処理をテストする場合は、trueに設定します。この場合、https://sandbox-secure.xsolla.comを使用してテスト決済UIにアクセスします。
デフォルト false
ユーザーID。テストでは、任意の値を渡すことができます。実際の支払いを受け入れるには、システムのユーザーID値を使用する必要があります。このIDはユーザー認証ウェブフックで渡されます。
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/catalog/v3/project/{project_id}/admin/payment/token
- https://store.xsolla.com/api/v3/project/{project_id}/admin/payment/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ja/api/catalog/v3/project/44056/admin/payment/token \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"items": [
{
"quantity": 2,
"sku": "com.xsolla.cup01"
},
{
"quantity": 1,
"sku": "com.xsolla.t-shirt01"
},
{
"quantity": 1,
"sku": "com.xsolla.cup01"
},
{
"quantity": 1,
"sku": "com.xsolla.hat01"
}
]
},
"settings": {
"currency": "USD",
"external_id": "AABBCCDD01",
"language": "de",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/ja/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
},
"user": {
"country": {
"allow_modify": false,
"value": "US"
},
"email": {
"value": "user@xsolla.com"
},
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
}
}
}'レスポンス
application/json
{ "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" }