Appdata

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

REST API NameHTTP MethodREST URI FragmentDescription
Create AppdataPOST/appdata/{userId}/{groupId}/{appId}Create application data
Get AppdataGET/appdata/{userId}/{groupId}/{appId}Acquires informaton specific to an app, such as a user's current score.
Update AppdataPUT/appdata/{userId}/{groupId}/{appId}Update the contents of one appdata
Delete AppdataDELETE/appdata/{userId}/{groupId}/{appId}Delete data of certain app

Data Type Definition

An isolated AppData

Simple hash of key/value pairs.

 

An AppData Collection

Simple hash of key/value pairs are stored by users in entry field.

Create Appdata

Description

Create Appdata for your application.

URI Fragment

/appdata/{userId}/{groupId}/{appId}

Supported Formats

JSON

HTTP Method

POST

Request Parameters

NameTypeRequiredParameterDescription
userIdUserId*URI Template ParametersOnly @me is specifiable
groupIdGroupId*URI Template ParametersOnly @self is specifiable
appIdAppId*URI Template ParametersOnly @app is specifiable
fieldsArray*Query StringThe keys of appdata are specifiable
formatString Query StringOnly json is specifiable

Request Body

An isolated AppData, which is defined by developers. 

 

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

HTTP Status CodeHTTP Status MessageMeaning
201CreatedData successfully created or updated
400Bad RequestCorrupt request data on the client side
401UnauthorizedAuthorization error
403ForbiddenThe resource exists, but access is not possible due to a reason other than an authorization error.
404Not FoundThe resource doesn’t exist
500Internal Server ErrorAn error on the API server side
503Service UnavailableThe API cannot be used temporarily

Response Body

N/A

Notes

1.Keys can be up to 32 bytes in size. Values can be up to 1024 bytes in size.

2.Maximum number of key/value pairs are 30 entries per user in an application.

 

Example.

HTTP Request
HTTP Response

 

 

Get Appdata

Description

Acquires informaton specific to an app, such as a user's current score.

URI Fragment

/appdata/{userId}/{groupId}/{appId}

Supported Formats

JSON

HTTP Method

GET

Request Parameters

NameTypeRequiredParameterDescription
userIdUserId*URI Template ParametersOnly @me is specifiable
groupIdGroupId*URI Template ParametersOnly @self is specifiable
appIdAppId*URI Template ParametersOnly @app is specifiable
fieldsArray Query StringThe keys of appdata are specifiable,  which are defined in "Create Appdata"
formatString Query StringOnly json is specifiable

Request Body

None

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 Body

a collection of Appdata

Response Status Code

HTTP Status CodeHTTP Status MessageMeaning
200OKData successfully acquired
400Bad RequestCorrupt request data on the client side
401UnauthorizedAuthorization error
403ForbiddenThe resource exists, but access is not possible due to a reason other than an authorization error.
404Not FoundThe resource doesn’t exist
500Internal Server ErrorAn error on the API server side
503Service UnavailableThe API cannot be used temporarily

Notes

 Leaving the fields parameter blank will return entire entries. If the target keys are known beforehand, the fields parameter must be specified.

 

Example .

HTTP Request
HTTP Response


Update Appdata

Description

Update the contents of one appdata

URI Fragment

/appdata/{userId}/{groupId}/{appId}

Supported Formats

JSON

HTTP Method

PUT

Request Parameters

NameTypeRequiredParameterDescription
userIdUserId*URI Template ParametersOnly @me is specifiable
groupIdGroupId*URI Template ParametersOnly @self is specifiable
appIdAppId*URI Template ParametersOnly @app is specifiable
fieldsArray*Query StringThe keys of appdata are specifiable
formatString Query StringOnly json is specifiable

Request Body

An isolated AppData. Simple hash of key/value pairs.

{

  "key1" : "value1",
  "key2" : "value2"
}

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

HTTP Status CodeHTTP Status MessageMeaning
201CreatedData successfully created or updated
400Bad RequestCorrupt request data on the client side
401UnauthorizedAuthorization error
403ForbiddenThe resource exists, but access is not possible due to a reason other than an authorization error.
404Not FoundThe resource doesn’t exist
500Internal Server ErrorAn error on the API server side
503Service UnavailableThe API cannot be used temporarily

Response Body

N/A

Notes

1.Keys can be up to 32 bytes in size. Values can be up to 1024 bytes in size.

2.Maximum number of key/value pairs are 30 entries per user in an application.

 

Example.

HTTP Request
HTTP Response

 

 

Delete Appdata

Description

Delete appdata of certain app

URI Fragment

/appdata/{userId}/{groupId}/{appId}

Supported Formats

JSON

HTTP Method

DELETE

Request Parameters

NameTypeRequiredParameterDescription
userIdUserId*URI Template ParametersOnly @me is specifiable
groupIdGroupId*URI Template ParametersOnly @self is specifiable
appIdAppId*URI Template ParametersOnly @app is specifiable
fieldsArray*Query StringThe keys of appdata are specifiable, which are defined in "Create Appdata"
formatString Query StringOnly json is specifiable

Request Body

None

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 Body

None

Response Status Code

HTTP Status CodeHTTP Status MessageMeaning
202AcceptedData successfully deleted
400Bad RequestCorrupt request data on the client side
401UnauthorizedAuthorization error
403ForbiddenThe resource exists, but access is not possible due to a reason other than an authorization error.
404Not FoundThe resource doesn’t exist
500Internal Server ErrorAn error on the API server side
503Service UnavailableThe API cannot be used temporarily

Example

HTTP Request
HTTP Response

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 "&" 

ParameterDescriptionValue
oauth_consumer_keyThe Consumer Key for the applicationIssued when resist the application
oauth_nonceUnique value for each requestGenerated on the game server
oauth_signature_methodHash methodOnly HMAC-SHA1 is specifiable
oauth_timestampUNIX timestampGenerated on the game server
oauth_tokenThe token code

oauth_token is obtained from the token credential.

oauth_versionOAuth versionOnly 1.0

2. URL encode the following three parameters.

ParameterDescription
Request MethodHTTP Method to the API Server
API URLURL to the API Server (exclude query parameters)
OAuth ParametersA string Built in previous step

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.

ParameterValue
oauth_consumer_keyIssued when resist the application
oauth_nonceGenerated on the game server
oauth_signatureGenerated on the game server, Refer to Step 2. Generate the oauth_signature
oauth_signature_methodonly "HMAC-SHA1" is specifiable
oauth_timestampGenerated on the game server
oauth_token

oauth_token is obtained from the token credential.

oauth_versionOnly 1.0
Authorization Header Example

 

 

 


PREVIOUS

People

NEXT

Blacklist