Endpoint for Social API

Note: Social API includes Appdata API, Blacklist API, People API, Profanity API, Leaderboard API, Remote Notification API.

Mobage Simplified Chinese Platform

Mobage Traditional Chinese Platform

Data Type Definition

LeaderBoard

Leaderboard.scoreFormat Fields

These fields control the user score's displayValue element. Requested formatting can result in a displayValue element that is different from the raw value field.

Numeric Expression Fields

 Time Expression Fields

Score

Get Leaderboard

Description

Retrieves the app's leaderboards and the user's scores on the leaderboards.

URI Fragment

/leaderboards/{appId}

/leaderboards/{appId}/{leaderboardId}/{userId}/{groupId}

HTTP Method

GET

Supported Formats

JSON

Request Parameter

Get Leaderboard Request Parameters

Get Score Request Parameters

Request Headers

Any request to the Mobage REST APIs must include the Authorization header. For more details, see How to add the Authorization Header. 

Request Body

None

Response Body

• Collection of Leaderboards (in the case of /leaderboards/{appId})
• LeaderBoard (/leaderboards/{appId}/{leaderboardId})
• Collection of Scores (/leaderboards/{appId}/{leaderboardId}/{userId}/@all,/leaderboards/{appId}/{leaderboardId}/{userId}/@friends)
• Score (/leaderboards/{appId}/{userId}/@self)

Response Status Code

Example 1. Get All Leaderboards

Example 2. Get a LeaderBoard

Example 3. Get LeaderBoards with Specified IDs

Example 4. Get the Top 50 Ranked Scores

Example 5. Get My Friends' Score Ranking

Example 6. Get the Specified User's Score

Update Leaderboard

Description

Adds a user's score to the app's leaderboard.

URI Fragment

/leaderboards/{appId}/{leaderboardId}/{userId}/{groupId}

Supported Formats

JSON

HTTP Method

PUT

Request Parameters

Request Headers

Any request to the Mobage REST APIs must include the Authorization header. For more details, see How to add the Authorization Header . 

Response Status Code

Response Body

Score

Example 1. Update New Score

Example 2. Failed Attempt to Update a Leaderboard with a Lower Score

Example 3. Update a Leaderboard that has a defaultScore Value

Delete a Score from a Leaderboard

Description

Removes a user's score from the app's leaderboard.

URI Fragment

/leaderboards/{appId}/{leaderboardId}/{userId}/{groupId}

HTTP Method

DELETE

Request Parameters

Request Headers

Any request to the Mobage REST APIs must include the Authorization header. For more details, see How to add the Authorization Header . 

Request Body

None

Response Body

None

Response Status Code

Example . Delete Score

How to Add the Authorization Header

Step 1. Create the base string

1. build a string for OAuth parameters:  firstly sort the following parameters alphabetically and URL encode the names and values, then join name and value with "=", finally join name/value pairs with "&" 

2. URL encode the following three parameters.

3. join the encoded parameters with "&".

Step 2. Generate the oauth_signature

1. Build a secret by joining the Consumer Secret and  the Token Secret (obtained from the token credential) with "&".

2. Pass the base string and secret to the HMAC-SHA1 hashing algorithm.

3. the output of HMAC-SHA1 hashing algorithm is a binary string. Use base64 encode to produce the signature string.

A tool is provided to verify whether your signature is correct. Refer to Oauth Signature Tool. 

Step 3. Build the Authorization Header

Follow the steps to build the “Authorization” header:

1. URL encode the parameter names and values in the table below 

2. Double quote the value, join name and value with "=", join name/value pairs with "," 

3. Add realm parameter as an option

4. Add "OAuth " (including the space at the end) to the beginning of the header.

Authorization Header Example