RESTful API

Mobage プラットフォームでは、プラットフォーム上の各種データを取得、操作するために RESTful API を提供しています。RESTful API は目的によって 3 つのカテゴリに分かれています。

  • Authentication: ゲームサーバーを認証するための API、下記 RESTful API を利用するために必要です。
  • Bank: ゲームアイテムをゲーム内仮想通貨で購入するために利用する API です。
  • Social: Mobage が提供する各種ソーシャル機能を利用するための API です。
     
     
API カテゴリと実行環境(Production や Sandbox)によって、リクエスト送信先のエンドポイントが異なります。エンドポイントについてはこちらをご参照下さい。
 
Mobage RESTful API を利用するために、リクエストを認証する必要があります。認証についてはこちらをご参照下さい。
公開審査に通過するまでは、本番用の API は使用出来ません。
下記 RESTful URI Fragment の表記について:
{name}: 中括弧を含まない実際の値(ユーザIDやグループ名など)に置き換えて下さい。例:66608
{-list|,|name}: 中括弧を含まない実際の値をカンマで区切ったリストに置き換えて下さい。例:66608,66609

Smartphone アプリのみを対象とした利用可能な API です。(Shell App Framework 除く。Shell App Framework については、RESTful API Reference をご確認下さい)

 

Authentication

Mobage RESTful API を利用するためにゲームサーバーを認証し、RESTful API 呼び出すために必要なトークンを取得します。

HTTP Method & RESTful URI Fragment
POST /request_temporary_credential
POST /request_token

説明
認証処理の第一歩として temporary credential を取得します。
3-legged 認証のために access token credential を取得します。

Bank

Mobage Bank API の使い方
Bank API の詳細な使い方について、下記の各ページをご参照下さい。
ngCore SDK | Native SDK | Unity SDK

Debit

ゲーム内仮想通貨でゲームアイテムの購入処理を行います。具体的に、新規トランザクションの作成と、トランザクションのオープンとクローズ、キャンセルを行います。

HTTP Method & RESTful URI Fragment
POST /bank/debit/@app
PUT /bank/debit/@app/{transactionId}
GET /bank/debit/@app/{-list|,|transactionId}

説明
トランザクションの新規作成。
上記作成されたトランザクションをオープンやクローズ、またはキャンセルします。
指定トランザクションの情報を取得します。

Inventory

Mobage Developers に登録されているゲームアイテムの情報を取得します。

HTTP Method & RESTful URI Fragment
GET /bank/inventory/@app
GET /bank/inventory/@app/{-list|,|itemId}

説明
Mobage Developers に登録されているゲームアイテム一覧を取得します。
Mobage Developers に登録されている指定のゲームアイテム一覧を取得します。

Social

People

ユーザプロファイル情報とモバ友情報を取得します。

HTTP Method & RESTful URI Fragment
GET /people/{-list|,|userId}/{groupId}
GET /people/{-list|,|userId}/{groupId}/{-list|,|personId}

説明
ユーザプロファイル情報またはモバ友リストを取得します。
指定されたグループにいるユーザのプロファイル情報を取得します。あるユーザが別のユーザのモバ友かどうかの判定にも利用できます。

AppData

ユーザのゲームデータ(appdata と言います)を Mobage プラットフォームに保存、更新または削除します。

HTTP Method & RESTful URI Fragment
POST /appdata/{userId}/@self/@app
PUT /appdata/{userId}/@self/@app
GET /appdata/{-list|,|userId}/@self/@app
DELETE /appdata/{userId}/@self/@app

説明
ユーザデータを新規作成します。
既存ユーザデータを更新します。
ユーザデータを取得します。
ユーザデータを削除します。

Profanity

ユーザが入力した自由文に不適切な言葉が含まれているかどうか確認する API です。
ユーザがテキストを投稿する機能を有する箇所には必ず適用してください。ProfanityAPIで不適切と判断された投稿はアプリケーション上に表示しないでください。

HTTP Method & RESTful URI Fragment
GET /profanity

説明
指定されたテキストは不適切な言葉が含まれるかチェックします。

Blacklist

ユーザのブラックリストを取得します。

HTTP Method & RESTful URI Fragment
GET /blacklist/{-list|,|userId}/@all
GET /blacklist/{-list|,|userId}/@all/{-list|,|personId}

説明
指定ユーザのブラックリストおよびその中に登録されたユーザを取得します。
特定ユーザ(personId)が指定ユーザ(userId)のブラックリストに登録されていれば、それらのユーザの情報を取得します。特定ユーザが指定ユーザのブラックリストに登録されているかどうを確認する場合に利用できます。

Remote Notification

ユーザにリモート通知を送信します。

Remote Notification API の使い方
Remote Notification API の詳細な使い方について、下記の各ページをご参照下さい。
ngCore SDK | Native SDK | Unity SDK

HTTP Method & RESTful URI Fragment
POST /remote_notification/@app/{groupId}
POST /remote_notification/@app/@all/{recipientId}

説明
指定されたグループ(全ユーザ、iOSユーザのみ、Androidユーザのみ)にリモート通知を一斉送信します。
指定されたユーザにリモート通知を送信します。

Leaderboard

Mobage Developers に登録されたリーダーボードの情報を取得したり、リーダーボードに登録されたユーザスコアの取得や追加、更新、削除をします。

Leaderboard API の使い方
Leaderboard API の詳細な使い方について、下記の各ページをご参照下さい。
ngCore SDK | Native SDK | Unity SDK

HTTP Method & RESTful URI Fragment
GET /leaderboards/@app
GET /leaderboards/@app/{-list|,|leaderboardId}
GET /leaderboards/@app/{leaderboardId}/{userId}/{groupId}
PUT /leaderboards/@app/{leaderboardId}/{userId}/@self
DELETE /leaderboards/@app/{leaderboardId}/{userId}/@self

説明
リーダーボード一覧を取得します。
指定リーダーボードを取得します。
指定リーダーボードに登録されたユーザスコアを取得します。
指定リーダーボードに登録されたユーザスコアを追加、更新します。
指定リーダーボードに登録されたユーザスコアを削除します。

TextData

ユーザの自由入力テキスト(TextData)をプラットフォームに保存もしくはプラットフォームから取得します。TextData API で保存されたテキストは監視の対象となります。TextData を保存する前にまずは TextDataGroup を作成する必要があります。なお、TextDataGroup の作成は 2-legged 認証(Trusted モデル)で行う必要があります。

HTTP Method & RESTful URI Fragment
GET /textdata/@app/@all
GET /textdata/@app/{textdataGroupName}/@self
GET /textdata/@app/{textdataGroupName}/@all
GET /textdata/@app/{textdataGroupName}/@all/{textdataId}
POST /textdata/@app/@all
POST /textdata/@app/{textdataGroupName}/@all
PUT /textdata/@app/{textdataGroupName}/@all/{textdataId}
DELETE /textdata/@app/{textdataGroupName}/@self
DELETE /textdata/@app/{textdataGroupName}/@all/{textdataId}

説明
TextDataGroup 一覧を取得します。
指定された TextDataGroup を取得します。
指定された TextDataGroup に保存された TextData 一覧を取得します。
指定された TextData を取得します。
TextDataGroup を新規作成します。
TextData を新規作成します。
既存 TextData を更新します。
既存 TextDataGroup を削除します。
既存 TextData を削除します。

Achievement

Mobage Developers に登録された Achievement の情報を取得します。

Achievement API の使い方
Achievement API の詳細な使い方について、下記の各ページをご参照下さい。
ngCore SDK | Native SDK | Unity SDK

HTTP Method & RESTful URI Fragment
GET /achievements/@app
GET /achievements/@app/{-list|,|achievementId}

説明
Achievement 一覧を取得します。
指定 Achievement を取得します。

User Achievement

Mobage Developers に登録された Achievement に対するユーザの達成状況を取得、更新します。

User Achievement API の使い方
User Achievement API の詳細な使い方について、下記の各ページをご参照下さい。
ngCore SDK | Native SDK | Unity SDK

HTTP Method & RESTful URI Fragment
GET /people/{userId}/@self/achievements/@app
GET /people/{userId}/@self/achievements/@app/{achievementId}
GET /people/{userId}/@friends/achievements/@app/{achievementId}
PUT /people/{userId}/@self/achievements/@app/{achievementId}
POST /people/{userId}/@self/achievements/@app/{achievementId}/increment

説明
指定されたユーザーのアプリ内で作成・更新された Achievement 一覧を取得します。
指定されたユーザーの該当 Achievement の達成状況を取得します。
指定されたユーザーの友達の該当 Achievement の達成状況を取得します。
指定されたユーザーの Achievement を新規登録、もしくは更新します。
指定されたユーザーの Achievement の steps 値を新規登録、更新します。

PREVIOUS

iTunesConnectへのアップロード方法

NEXT

RESTful APIエンドポイント