RESTful API

The Mobage platform provides the following RESTful API for your app to interact with the platform. These API are divided into three categories:

Authentication: used to authorize your app server for subsequent RESTful API calls,
Bank: used for processing in-game virtual item purchase,
Social: let you access various social functions on Mobage platform

Depending on the API category and environment, your requests must be sent to different endpoints as summarized here.

For more details on how to authenticate with the Mobage RESTful API server, please see here.

Your app is not allowed to use the Production APIs or endpoints before it passes the Application Release Review process.

Notation used in below RESTful URI Fragments:
{name}: Replace this with an actual value (i.e. user ID, group name, etc.) according to the context, without curly braces.
{-list|,|name}: A comma-separated list of values, without curly braces.

These APIs can be used in Smartphone apps, excluding those using Shell App Framework.

Authentication

Authorizes with Mobage RESTful API server.

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

Description
Requests temporary credentials as first step of authentication.
Requests access token credentials for subsequent REST API calls.

Bank

How to use Mobage Bank API
For more details on how to use the Mobage Bank API, please refer to the following pages.
ngCore SDK | Native SDK | Unity SDK

Debit

Creates transaction and updates transaction state for virtual item purchase using virtual currency.

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

Description
Creates a new transaction.
Update transaction state to open, close or cancel the transaction.
Retrieves information about specific transaction(s).

Inventory

Retrieves virtual item inventory registered on the Mobage platform in Mobage Developers.

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

Description
Retrieves all virtual items registered on the Mobage platform in Mobage Developers.
Retrieves specified virtual item(s) registered on the Mobage platform in Mobage Developers.

People

Retrieves user profile information and friend list.

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

Description
Retrieve user profile information or friend list.
Retrieve user profile information if the specific user(s) are in the group. Can be used to determine whether a user is another's friend.

AppData

Stores, updates and deletes user app data on Mobage platform.

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

Description
Creates user app data.
Update user app data.
Gets user app data.
Deletes user app data.

Profanity

Verifies whether text violates the profanity policy.

HTTP Method & RESTful URI Fragment
GET /profanity

Description
Verifies whether text violates the profanity policy.

Blacklist

Queries the blacklists of specific users.

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

Description
Retrieves all users registered in a user's blacklist.
Retrieves user information if the specific user(s) are registered in a user's blacklist. Can be used to check whether a user is in another's blacklist.

Remote Notification

Sends remote notifications to users.

How to use Remote Notification API
For more details on how to use the Remote Notification API, please refer to the following pages.
ngCore SDK | Native SDK | Unity SDK

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

Description
Sends remote notification to a specific group of users.
Sends remote notification to a specific user.

Leaderboard

Retrieves information about leaderborads registered for an app in Mobage Developers. Creates, updates, deletes and retrieves users' scores on those leaderboards.

How to use Leaderboard API
For more details on how to use the Leaderboard API, please refer to the following pages.
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

Description
Retrieves all app's leaderboards.
Retrieves the specified leaderboards.
Retrieves users' scores on the specified leaderboard.
Updates user score on the specified leaderboard.
Deletes user score on the specified leaderboard.

TextData

Stores and retrieves user created text (TextData) to or from the platform. Stored TextData are subject to monitoring. TextDataGroup must be created before you can store TextData in the group. TextDataGroup can be created using below API based on 2-legged authentication model (Trusted Model).

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}

Description
Retrieves the list of TextDataGroup for an app.
Retrieves information about a TextDataGroup for an app.
Retrieves list of texts stored within a TextDataGroup.
Retrieves a specific text.
Creates a new TextDataGroup.
Creates a new TextData.
Updates an existing TextData.
Deletes a TextDataGroup.
Deletes a TextData.

Achievement

Retrieves the list of Achievements registered in Mobage Developers portal.

How to use Achievement API
For more details on how to use the Achievement API, please refer to the following pages.
ngCore SDK | Native SDK | Unity SDK

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

Description
Retrieves the list of Achievements.
Retrieves the sepecified Achievement.

User Achievement

Retrieves the achievement record for users.

How to use User Achievement API
For more details on how to use the User Achievement API, please refer to the following pages.
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

Description
Retrieves the list of achievements achieved or updated for a user.
Retrieves the achievement status of a user for the specified achievement.
Retrieves the achievement status of friends of a user for the specified achievement.
Create new or update achievement status for a user.
Create or update the steps value for an achievement of a user.

MobageCard Incentive

As part of the privileges enjoyed by users who are using MOBAGE CARD (Credit Card), this API can be used to retrieve the user's incentive level and update the incentive state of the user. For more information about the incentive system, read here.

How to use MobageCard Incentive API
For more details on how to use the MobageCard Incentive API, please refer to the following pages.
[ngCore SDK] | [Native SDK] | [Unity SDK]

HTTP Method & RESTful URI Fragment
GET /people/{userId}/@self/mobagecard
GET /people/{userId}/@self/mobagecard/{incentiveId}
PUT /people/{userId}/@self/mobagecard/{incentiveId}

説明
Retrieves the latest incentive ID of the user.
Retrieves the specific incentive ID of the user.
Consumes an incentive.