メインコンテンツまでスキップ

Bank Inventory

概要​

ゲームアイテム情報の作成/更新/取得/削除をおこなうAPIです。

備考

モバコインによるアイテム課金の詳細についてはチュートリアルもご参照下さい。

Bank Inventory オブジェクトフィールド​

Bank Inventory API へリクエストを行うと、Bank Inventory オブジェクトが返却されます。

値説明型
idアイテム IDxs:string
nameアイテム名xs:string
priceアイテムの価格xs:int
descriptionアイテムの説明文xs:string
imageUrlアイテム画像の URLxs:string

エンドポイントURL​

Sandbox環境

https://sb-app.mobage.jp/social/api/restful/v2.02/bank/inventory/{appid}/{-list|,|itemId}

本番環境

https://app.mobage.jp/social/api/restful/v2.02/bank/inventory/{appid}/{-list|,|itemId}

APIリクエスト​

HTTP メソッド​

  • Authorization Code Grant
    • GET 登録されているゲームアイテム一覧を取得します。
  • Client Credentials Grant
    • GET 登録されているゲームアイテム一覧を取得します。
    • POST ゲームアイテム情報を作成します。
    • PUT ゲームアイテム情報を更新します。
    • DELETE ゲームアイテム情報を削除します。

APIレスポンス​

HTTPステータスコードHTTP ステータスメッセージ説明
200OKデータ取得が成功した場合
201Createdデータ取得が生成した場合
202Acceptedデータ取得が更新した場合
400Bad Requestクライアント側のリクエストデータが不正です
401Unauthorized認証エラーです
403Forbiddenリソースは存在するが認証エラー以外の理由でアクセス出来ない場合です
404Not Found存在しないリソースです
500Internal Server ErrorAPI サーバー側のエラーです
503Service Unavailable一時的に API が利用不可となっている場合です

サンプル​

登録されている全てのアイテム一覧の取得​

リクエスト形式​

GET /social/api/restful/v2.02/bank/inventory/@app

レスポンス形式​

200 OK

{
"entry":[
{"id":"life_pack_1"},
{"id":"booster"}
],
"startIndex":1,
"sorted":false,
"itemsPerPage":2,
"updatedSince":false,
"totalResults":2,
"filtered":false
}

指定されたアイテムのみの取得​

リクエスト形式​

GET /social/api/restful/v2.02/bank/inventory/@app/booster,life_pack_1?fields=price,description

レスポンス形式​

200 OK
{
"entry":[
{
"id":"booster",
"price":200,
"description":"A booster that doubles your score immediately."
},
{
"id":"life_pack_1",
"price":100,
"description":"You got 3 life."
}
],
"startIndex":1,
"sorted":false,
"itemsPerPage":2,
"updatedSince":false,
"totalResults":2,
"filtered":false
}

アイテム情報を生成する​

リクエスト形式​

POST /social/api/restful/v2.02/bank/inventory/@app
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9
Content-Type: application/json; charset=utf-8

{
"id":"life_pack_2",
"name": "Sample Item2",
"price": 100,
"imageUrl": "http:\/\/mobage.com\/homepage-assets\/images\/icon.png",
"description": "This is a sample item"
}

レスポンス形式​

201 Created

アイテム情報を更新する​

リクエスト形式​

PUT /social/api/restful/v2.02/bank/inventory/@app/life_pack_2?fields=price,imageUrl
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9
Content-Type: application/json; charset=utf-8
 
{
"price": 350,
"imageUrl": "ttp:\/\/mobage.com\/homepage-assets\/images\/icon2.png",
}

レスポンス形式​

202 Accepted

アイテム情報を削除する​

リクエスト形式​

DELETE /social/api/restful/v2.02/bank/inventory/@app/life_pack_2
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9
Content-Type: application/json; charset=utf-8

レスポンス形式​

202 Accepted