Version 1.0

This tutorial will go through the step-by-step instructions to integrate the Login feature to a Unity3d game project.

Unity3D version 4.6 or later

Open Unity Editor and double click package GoPlaySDK_v1.XX.unitypackage to import all necessary environment. Or you can choose Assets > Import Package > Custom Package… and choose GoPlaySDK _v1.XX.unitypackage location.

GoPlay provides dev server and production server. To setup the Live server build or Test server build, configure the Boolean variable UseLiveServer in GoPlaySDK.cs. Set it to True to use production server, False for dev server.

public bool UseLiveServer {get; set;}

To start using the SDK, we need to set up the GAME_ID of the current project. The value helps GoPlay server identify which game connecting to it. Choose from Unity3D menu, GoPlaySDK > Setting to open Setting Dialog.

GoPlaySDK uses an Event subscription mechanism. Each API call is a HTTP asynchronous web request. When a response callback is available, an Event will be triggered. Client application can easily subscribe to these events.

GoPlaySdk.Instance.OnLogin += OnLogin;

void OnLogin(IResult callback)
{
  var result = callback as LoginResult;
  if (result != null)
  {
    // Yipee…
  }
}

For a full listing of the source code sample, please refer to the sample Unity project in the SDK package.

1. API Calls
2. Login
3. Register
4. Logout
5. Get Profile
6. Edit Profile
7. Get Progress
8. Save Progress
9. Save Progress File
10. Read Progress
11. Update Game Stats
12. Get Unfulfilled Exchanges
13. Fulfill Exchange
14. Reject Exchange
15. Supporting Classes
16. Session
17. UserProfile
18. Exchange
19. GameStat

public void Login(string userName, string password)
public void Login(SocialPlatforms platform, string token)

This method perform a log-in to GoPlaySDK using a username and password. A user account must be available before calling this method. An event will be triggered when server callbacks. This event must be hooked up before calling this method.

If user login via facebook account, the server will bind the user with the facebook account for future auto-login.

Example:

GoPlaySdk.Instance.OnLogin+= HandleOnLogin;

GoPlaySdk.Instance.Login(Username.text, Password.text);

#####Input

• INVALID_USN_PWD - 'Username or Password is incorrect'
• MISSING_FIELDS - 'Required field(s) is blank'
• INVALID_GAME_ID - 'Invalid Game ID'

public void Register(string userName, string password, string email = null, string nickName = null, Gender gender = Gender.Other, string referal = null)

This method is used to explicitly register a new customer account. An event will be triggered when server callbacks. This event must be hooked up before calling the API.

If user registers by using a facebook account, the server will bind the user with the facebook account for future auto-login.

Example:

GoPlaySdk.Instance.OnRegister += OnRegister;

GoPlaySdk.Instance.Register(Username.text,Password.text,Email.text);

#####Input

• EXISTING_USERNAME_EMAIL- 'Account with such username/email already exists'
• MISSING_FIELDS - 'Required field(s) is blank'
• INVALID_GAME_ID - 'Invalid Game ID'
• USERNAME_LENGTH - 'Username is between 3-20 characters'
• INVALID_USERNAME - 'Username does not accept special characters'
• PASSWORD_LENGTH - 'Password must be more than 3 characters'

This method logs out a player from GoPlay server.

Example:

GoPlaySdk.Instance.LogOut();

public void GetProfile()

Call this method to retrieve the profile of a user. An event will be triggered when server callbacks. This event must be hooked up before calling the API.

Example:

GoPlaySdk.Instance.OnGetProfile += HandleOnGetProfile

GoPlaySdk.Instance.GetProfile();

#####Input

• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’

public void EditProfile(string email=null, string nickName=null, Gender?  gender=null )

Call this method to updates the profile of a user. Parameters may be omitted, and those fields will be unchanged. An event will be triggered when server callbacks. This event must be hooked up before calling the API.

Example:

GoPlaySdk.Instance.OnEditProfile += HandleOnEditProfile;
GoPlaySdk.Instance.EditProfile(Email.text,NickName.text);

#####Input

• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’

public void GetProgress(bool sendData)

Call this method to retrieve game progress directly from GoPlay server. The progress is saved in a string field, either as xml or json. The progress is saved together with a meta field. An event will be triggered when server callbacks. This event must be hooked up before calling the API.

Example:

GoPlaySdk.Instance.OnGetProgress += HandleOnGetProgress;
GoPlaySdk.Instance.GetProgress (true);

#####Input

• MISSING_FIELDS - ‘Required field(s) is blank’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’

public void SaveProgress(string data, string meta=null)

Call this method to save game progress to GoPlay server.

Example:

GoPlaySdk.Instance.OnSaveProgress += HandleOnSaveProgress;
GoPlaySdk.Instance.SaveProgess(data);

#####Input

• MISSING_FIELDS - ‘Required field(s) is blank’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’

public void SaveProgressFile(string fullPath, string meta=null)

Call this method to save game progress file of any extension to GoPlay server.

Example:

GoPlaySdk.Instance.OnSaveProgress += HandleOnSaveProgress;
GoPlaySdk.Instance.SaveProgessFile(Application.dataPath + "/Sample/Sample1/data.json");

#####Input

• MISSING_FIELDS - ‘Required field(s) is blank’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’

public void ReadProgress(string fullPath)

Because the game progress storage file is protected, call this method to download game progress file from GoPlay server.

Example:

GoPlaySdk.Instance.OnReadProgress += HandleOnReadProgress;
GoPlaySdk.Instance.ReadProgress(Application.dataPath + "/Sample/Sample1/downloaded.json");

#####Input

• MISSING_FIELDS - ‘Required field(s) is blank’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’
• NON_EXISTING_FILENAME - 'Filename does not exist'
• ERROR_READING_FILE

public void UpdateGameStats(string gameId, GameStats stats

Call this method in game client to save game stats directly to GoPlay server. The stat is saved as a string. An event will be triggered when server callbacks. This event must be hooked up before calling the API.

Example:

GoPlaySdk.Instance.OnUpdateGameStats += HandleOnUpdateGameStats;
GoPlaySdk.Instance.UpdateGameStats(GameId,gameStats);

#####Input

• MISSING_FIELDS - ‘Required field(s) is blank’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_GAME_ID - ‘Invalid Game ID’
• INVALID_GAME_STAT - ‘Invalid stat format. A stat JSON must include 3 keys title, value and public with their values.’

public void GetUnFullFilledExchanges(string gameId)

Returns a list of unfulfilled exchanges made on GoPlay website An event will be triggered when server callbacks. This event must be hooked up before calling the API.

Example:

GoPlaySdk.Instance.OnGetUnFullFilledExchanges+= HandleOnGetUnFullFilledExchanges;
GoPlaySdk.Instance.GetUnFullFilledExchanges() ;

#####Input

• INVALID_GAME_ID - ‘Invalid Game ID’
• INVALID_SESSION - ‘Invalid Session’

public void FullFillExchange(string gameId, string transactionId)

Call this method to fulfill an exchange made on GoPlay website. An event will be triggered when server callbacks. This event must be hooked up before calling the API.

Example:

GoPlaySdk.Instance.OnFullFillExchange+= HandleOnFullFillExchange;
GoPlaySdk.Instance.FulfillExchange(GameId,transId);

#####Input

• INVALID_GAME_ID - ‘Invalid Game ID’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_TRANSACTION_ID - ‘Invalid Transaction ID’
• TRANSACTION_ALREADY_PROCESSED - ‘Transaction has already been processed’

public void RejectExchange(string transactionId)

Reject an exchange made on GoPlay website. The rejected exchange’s status will be changed to failure and the user’s balance is redeemed.

Example:

GoPlaySdk.Instance.OnRejectExchange += HandleOnRejectExchange;
GoPlaySdk.Instance.RejectExchange(transactionId) ;

#####Input

• INVALID_GAME_ID - ‘Invalid Game ID’
• INVALID_SESSION - ‘Invalid Session’
• INVALID_TRANSACTION_ID - ‘Invalid Transaction ID’
• TRANSACTION_ALREADY_PROCESSED - ‘Transaction has already been processed’

Contains all information regarding the player’s session, such as session ID, game ID and current user.

All the information about user such as username, password, Gender, etc.

This class holds information about user’s transactions.

A JSON object representing a game stat, with the following keys: