People

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

User

NameTypeDescriptionCNJPWW
idUserIdThe user's ID value***
displayNameStringThe user’s display name (same value as nickname)***
aboutMeStringIntroduction text about the user** 
addressesPlural-Field<Address>Where the user lives (name of prefecture)** 
ageNumberThe user’s age***
birthdayDateThe user’s birthday** 
genderStringThe user’s gender** 
hasAppBooleanWhether or not the user has installed that application***
interestsPlural-Field<string>The user’s interests** 
nicknameStringThe user’s nickname***
thumbnailUrlStringThe URL for the user’s thumbnail***
jobTypeStringThe user’s occupation** 
bloodTypeStringThe user’s blood type** 
ageRestrictedBooleanWhether or not the user has been restricted by age  *

Description

This is an API for acquiring user profile information and user friend lists.

URI Fragment

/people/{-list|,|userId}/{groupId}

/people/{-list|,|userId}/{groupId}/{-list|,|personId}

Supported Formats

JSON

HTTP Method

GET

Request Parameters

NameTypeRequired/OptionalParameterDescription
userIdUserId, ArrayRequiredURI Template Parameters@me or direct value
groupIdGroupIdRequiredURI Template ParametersThe only legal values are @all, @self, or @friends.
personIdUserId, Array OptionalURI Template Parametersdirect value
fieldsArray OptionalQuery Stringthe names in the data type User for the CN platform
formatString OptionalQuery StringOnly json is specifiable
filterByString or Array OptionalQuery StringThe specifiable fields are id and hasApp
filterOpString or Array OptionalQuery Stringequals is the only specifiable operator
filterValueString or Array OptionalQuery StringThe values for filter keys.
countNumber OptionalQuery StringAn integer between 1 and 1000. The default value is 50.
sortByString OptionalQuery StringOnly id is specifiable.
sortOrderString OptionalQuery Stringascending or descending
startIndexNumber OptionalQuery StringAn integer of 1 or greater

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

  • User (in the case of either /people/{userId}/@self or /people/{userId}/@all/{personId}, /people/{userId}/@friends/{personId})
  • Collection of Users (in all other cases)

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

 If the fields parameters are omitted, the user's ID and nickname are selected. The user ID and nickname are returned in every response.

Example 1. Acquire User Profile Information

HTTP Request
HTTP Response

Example 2. Acquire a List of the User's Friends

HTTP Request
HTTP Response

 

Example 3. Determining whether the Specified User is a Friend

HTTP Request

Http Response is as follows if a specified user is a friend:

HTTP Response

Http Response is as follows if the user is not a friend.

HTTP Response

Example 4. Verify the Current User

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

Blacklist

NEXT

Profanity