Skip to main content

Register/Login

Workflow

Register

  1. Users login to the Third Party Portal, the Third Party Portal handles authorization on its own
  2. To play the game, users open the game popup
  3. The Third Party Portal will send Register to the game in Eagles a. If it is the first time user play this game, we will create new user in the system for this game, otherwise user will be updated data
  4. The Eagles Team responses with a redirectUrl which The Third Party Portal can use in a iframe

API

  • Description
    • Register function is used to get a signature token for player who logins/registers Eagles system
    • The token is considered as one time password for this login or register session and it will be expired in 20 seconds.
    • You will get URL from this function,then move on to next function to complete the url. Player is required to carry this token to visit our website in order for authentication https://{eagles-system-domain}?signature-token={token}
  • Headers
    • X-Company-Key
    • X-Server-ID
  • URL
PathMethod
/auth/registerPOST
  • Request
ParameterTypeDescription *as Required
username*stringShould be a unique player name (Number, Letter, and _ only). (must be 6 to 20 characters)
display_name*stringThe name that will be displayed in this game, must be 4 to 20 characters
avatarstringThe URL contains an image that will be displayed in this game
framestringThe URL contains an image that will be displayed in this game
  • Response
ParameterTypeDescription
urlstringUrl contains a token that the Third Party Portal can use in an iframe to visit our website for authentication.
  • Example
NameSample
Request{"username": "player-01", "display_name": "hi i am tony", "avatar": "https://example.com/avatar.png","frame": "https://example.com/frame.png"}
Response{"url": "https://exmaple.com?signature-token=token123"}