More Than Game API 1.0

More Than Game API 1.0
More Than Game API 1.0
OVERVIEW
El API está dividido en 3 Niveles de Acceso:
The API allows 3 levels of access:
Level 1) User
All users will be able to access this level. It presents all the information at the basic user
level. Profile, Games, Friends, Wall.
Level 2) Developer
Preview developer "Developers General Conditions" agreement approval, Developer will
have access to this level.
Creating and Modifying Access Games, Platforms and Content; inApps, Achievements,
Rankins, etc.
More Than Game API 1.0
Table of contents
Generals
Signature Generation
User Framework
User Login (W)
NEW: User Autologin
Facebook Login
User Logout(W)
User Balance(W)
Get Friend List(W)
Friendship Request(W)
Friendship Accept/Reject(W)
Get Black List(W)
Add To Black List(W)
Remove From Black List(W)
[MOD]Get Achievements List
Earn badge
Buy InApp
[MOD]List my shopping
Consume InApp
(MOD)Share/Send Message
[MOD]GetWall
Get Score
Submit Score
Gift Coins(W)
(*)Referrals
NEW: Search Friends
Developer Framework
Create Account(W)
Create Account From FaceBook
Validate email
Modify Account(W)
Get Game Ranking
Get Game InApps
Get Game Achievements
MTG Framework
Inject Coins(W)
Consume Coins(W)
Sign Contract Level
Delete Account
Create/Modify InApp
Delete InApp
[MOD]Create/Modify Badge
Delete Badge
More Than Game API 1.0
Upload Image
Remove Image
Create Game
Add/Modify Platform
Get Platforms
Remove Platform
Delete Game
[MOD]List Games
Add Review
[MOD]NEW: Get Game Reviews
***: Activate Game
More Than Game API 1.0
Generals
Signature Generation
The sign is obtained through changing parameters collection string to lowercase and then
MD5. Please, pay attention to the order of the parameters in the sign. Keep the same order
as the function description.
Example for user login:
md5(
lower(“DeveloperKey=XXYYZZ&Function=login&GameID=XXYYZZ&[email protected]
&Password=123ABC”)
)
More Than Game API 1.0
User Framework
This part refers to all methods that affect the user. They may be called public and only
AccessToken will be invoked.
URL: https://www.morethangame.com/user
User Login (W)
Parameters
Function:
GameID:
Login:
Password:
Signature:
‘login’
game hash id.
account name.
md5(crypt(password,$1$geanetod$)+GameID).
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid game ID.
-3 - User or pass error.
UserID:
user hash id.
Nick:
nick.
Avatar:
avatar url.
AccessToken:
access token.
Description
Validate user credentials against the user framework.
BI: Player plays this game.
More Than Game API 1.0
NEW: User Autologin
Parameters
Function:
‘autologin’
GameID:
game hash id.
UserID:
user has ID.
AccessToken: access token.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid game ID.
-3 - User or pass error.
Nick:
Avatar:
nick.
avatar url.
Description
Validate user credentials against the user framework.
More Than Game API 1.0
Facebook Login
Parameters
Function:
‘fblogin’
MediaID:
media hash id.
GameID:
game hash id.
AccessToken: facebook access token.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid game ID.
-3 - Invalid media ID.
-4 - Invalid access token.
UserID:
user hash id.
Nick:
nick.
Avatar:
avatar url.
AccessToken: access token.
Description
Validate or create account using facebook credentials.
More Than Game API 1.0
User Logout(W)
Parameters
Function:
‘logout’
UserID:
User ID.
AccessToken: access token.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
Description
Logout user from the framework.
More Than Game API 1.0
User Balance(W)
Parameters
Function:
‘balance’
UserID:
User ID.
AccessToken: access token.
Signature:
signature.
Returns
Error:
Balance:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
-3 - Invalid user ID.
Current user balance.
Description
Get user balance.
(* Further User Query )
More Than Game API 1.0
Get Friend List(W)
Parameters
Function:
‘listfriend’
UserID:
User ID.
AccessToken: access token.
Signature:
signature.
Returns
Error:
Items:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
-3 - Invalid user ID
[{UserID,Nick,Avatar,Request}].
Description
Get friends list. Also, shows friendships request.
(* Paginated?)
More Than Game API 1.0
Friendship Request(W)
Parameters
Function:
‘requestfriend’
UserID:
User ID.
AccessToken: access token.
FriendID:
Friend ID.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
-3 - Invalid friend ID.
Description
Send friendship request to a friend.
More Than Game API 1.0
Friendship Accept/Reject(W)
Parameters
Function:
‘acceptfriend’
UserID:
User ID.
AccessToken: access token.
RequestID:
Request ID.
Response:
response.
‘accept’ or ‘reject’.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
-3 - Invalid user ID.
-4 - Invalid requestID.
Description
Accept or reject friendship request.
More Than Game API 1.0
Get Black List(W)
Parameters
Function:
‘listblack’
UserID:
User ID.
AccessToken: access token.
Signature:
signature.
Returns
Error:
Items:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
[{UserID,Nick,Avatar}].
Description
Get black list.
(* Paginated?)
More Than Game API 1.0
Add To Black List(W)
Parameters
Function:
‘addblack’
UserID:
User ID.
AccessToken: access token.
OtherID:
other ID.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
-3 - Invalid User ID.
-4 - Invalid other user ID.
Description
Add user to the black list.
More Than Game API 1.0
Remove From Black List(W)
Parameters
Function:
‘removeblack’
UserID:
User ID.
AccessToken: access token.
OtherID:
other ID.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid access token.
-3 - Invalid user ID.
-4 - Invalid other user ID.
Description
Remove user from the black list.
More Than Game API 1.0
[MOD]Get Achievements List
Parameters
Function:
‘userachievements’
UserID:
User ID.
AccessToken: access token.
[GameID]:
Game ID.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
Items:
[{BadgeID, BadgeTitle,GameID,Progress, URLImageEarned,
URLImagePending,LastModDateTime}].
Description
Get achievements list.
(* Paginated?)
More Than Game API 1.0
Earn badge
Parameters
Function:
‘earnbadge’
UserID:
User ID.
AccessToken: access token.
BadgeID:
Badge ID.
Percent:
percent.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID
-3 - Invalid access token.
-4 - Invalid badge ID.
Description
Sets the percent of achievement.
More Than Game API 1.0
Buy InApp
Parameters
Function:
‘buy’
UserID:
User ID.
AccessToken: access token.
InAppID:
InApp ID.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
-4 - Invalid InApp ID.
-5 - Not enough credit.
Description
Buy a InApp.
More Than Game API 1.0
[MOD]List my shopping
Parameters
Function:
‘myinapps’
UserID:
User ID.
AccessToken: access token.
GameID:
Game ID.
Signature:
signature.
Returns
Error:
Items:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
-4 - Invalid game ID.
[ ItemID, InAppID, Ammount,Status,DATETIME]
Description
Get my shopping list.
More Than Game API 1.0
Consume InApp
Parameters
Function:
‘consumeinapp’
UserID:
User ID.
AccessToken: access token.
GameID:
Game ID.
ItemID: Item ID.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
-4 - Invalid game ID.
-5 - Invalid item ID.
Description
Summit user’s score.
More Than Game API 1.0
(MOD)Share/Send Message
Parameters
Function:
‘share’
UserID:
User ID.
AccessToken: access token.
GameID:
game hash ID.
TargetID:
target ID, userID, public, game, comment, etc.
(NEW)MessageID: this is a reply to message ID.
Message:
message text.
ImageURL:
image URL.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
-4 - Invalid game ID.
-5 - Invalid target ID.
Description
Send message to a target.
More Than Game API 1.0
[MOD]GetWall
Parameters
Function:
UserID:
TargetID:
Signature:
‘getwall’
user ID
target ID, userID, public, game, comment, etc.
signature.
Returns
Error:
Items:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid target ID.
[‘MessageID’,’UserID’,’TargetID’,’Content’,’MessageIDReply’,’URL’,DateTime]
Description
Returns entries filtered by target.
More Than Game API 1.0
Get Score
Parameters
Function:
‘getscore’
UserID:
User ID.
AccessToken: access token.
GameID:
Game ID.
Signature:
signature.
Returns
Error:
Score:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
-4 - Invalid game ID.
-5 - Invalid game user
score.
Description
Get score for the GameID.
More Than Game API 1.0
Submit Score
Parameters
Function:
‘setscore’
UserID:
User ID.
AccessToken: access token.
GameID:
Game ID.
Score:
score.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid access token.
-4 - Invalid game ID.
-5 - Invalid score.
-6 - Invalid game user.
Description
Summit user’s score.
More Than Game API 1.0
Gift Coins(W)
Parameters
Function:
‘giftcoins’
UserID:
user ID.
AccessToken: access token.
OtherID:
other user ID.
Amount:
amount.
Signature:
signature.
Returns
Error: error value.
0 - no error.
-1 - Invalid signature.
-2 - Inalid userID
-3 - Invalid access token.
-4 - Invalid other ID.
-5 - Invalid amount.
-6 - Amount > balance
Description
Gifts coins to other user.
More Than Game API 1.0
(*)Referrals
Parameters
Function:
Signature:
‘referral’
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
Description
Referrals.
More Than Game API 1.0
NEW: Search Friends
Parameters
Function:
Nick:
Signature:
‘searchfriends’
nick name.
signature.
Returns
Error:
ID:
error value.
0 - no error.
-1 - Invalid signature.
-2 - not found.
friend ID.
Description
Looking for a friend by nick.
More Than Game API 1.0
Developer Framework
This part refers to all methods that affect the developer. They may be called so public, and
only GameID token needed to be invoked.
URL: https://www.morethangame.com/developer
Create Account(W)
Parameters
Function:
MediaID:
GameID:
UNick:
Password:
Avatar:
eMail:
Robinson:
Signature:
‘create’
media hash id.
game hash id.
Unique nickname.
Password.
Avatar Url.
eMail.
True, don’t want to receive commercial info.
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid game ID.
-3 - Invalid Unique Nick.
-4 - Invalid email.
-5 - Invalid media ID.
Description
Create a new user account. The MediaID is one of the parameter passed to the game.
More Than Game API 1.0
Create Account From FaceBook
Parameters
Function:
‘createfacebook’
MediaID:
media hash id.
GameID:
game hash id.
AccessToken: facebook access token.
Robinson:
True, don’t want to receive commercial info.
Signature:
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid media ID.
-3 - Invalid game ID.
-4 - Invalid access token.
Description
Create a new user account through facebook. The MediaID is one of the parameter passed
to the game.
More Than Game API 1.0
Validate email
Parameters
Function:
UserID:
Token:
Signature:
‘validate’
user hash id.
Hash token..
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid token.
Description
Validates a email for a user account.
More Than Game API 1.0
Modify Account(W)
Parameters
Function:
UserID:
UNick:
Password:
Avatar:
eMail:
Robinson:
Signature:
‘modify’
user hash id.
Unique nickname.
Password.
Avatar Url.
eMail.
True, don’t want to receive commercial info.
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid user ID.
-3 - Invalid unique nick.
-4 - Invalid email.
Description
Modify user account.
More Than Game API 1.0
Get Game Ranking
Parameters
Function:
GameID:
Signature:
‘ranking’
Game ID.
signature.
Returns
Error:
Items:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid game ID.
[UserID,AvatarURL,Score/Value]
Description
Get game ranking.
(* paginated)
More Than Game API 1.0
Get Game InApps
Parameters
Function:
GameID:
Signature:
‘listinapps’
Game ID.
signature.
Returns
Error:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid game ID.
Items:
[InAppID, Title, ImageURL,Description,Price,Type,Active]
Description
List all InApps for a game.
More Than Game API 1.0
Get Game Achievements
Parameters
Funccreate /mtion:
‘gameachievements’
GameID:
Game ID.
Signature:
signature.
Returns
Error:
Items:
error value.
0 - no error.
-1 - Invalid signature.
-2 - Invalid gameID.
[BadgeID, Title, PendigImageURL,Description]
Description
List achievements for a game.
More Than Game API 1.0