Authentication
This endpoint is used to authenticate users and perform various actions such as device login, email login, and registration.
URL: https://api.idosgames.com/api/[titleTemplateId]/[titleId]/Client/Authentication/
LoginWithDeviceID
Purpose: Allows a user to log in using their device ID. URL:
Method: POST
Request Parameters (JSON body)
deviceID
(string): The unique identifier of the user's device.platform
(string): The platform the device is running on (e.g., Android, iOS).device
(string): Information about the device (e.g., model or type).ip
(string, optional): The user's IP address.userName
(string, optional): The user's username.
Responses
200 OK: Successful login. Returns a
GetAllUserDataResult
object with user data.400 Bad Request: Incorrect request parameters. Returns an error message, e.g., "INVALID_INPUT_DATA".
Example Usage
Request:
Response:
LoginWithEmail
Purpose: Allows a user to log in using their email and password. URL:
Method: POST
Request Parameters (JSON body)
email
(string): The user's email address.password
(string): The user's password.
Responses
200 OK: Successful login. Returns a
GetAllUserDataResult
object with user data.400 Bad Request: Incorrect request parameters or invalid credentials. Possible messages: "INVALID_INPUT_DATA", "USER_NOT_FOUND", "INCORRECT_PASSWORD".
Example Usage
Request:
Response:
AddEmailAndPassword
Purpose: Adds an email and password to an existing user's account. URL:
Method: POST
Request Parameters (JSON body)
userID
(string): The user's unique identifier.email
(string): The email address to be added.password
(string): The password to be added.clientSessionTicket
(string): The session ticket for authenticating the current session.
Responses
200 OK: Operation successful. Returns a success message.
400 Bad Request: Incorrect request parameters or validation error. Possible messages: "INVALID_INPUT_DATA", "USER_NOT_FOUND", "SESSION_EXPIRED", "INVALID_SESSION_TICKET", "EMAIL_ALREADY_EXISTS", "FAILED_TO_SAVE_TO_DATABASE".
Example Usage
Request:
Response:
RegisterUserByEmail
Purpose: Registers a new user using their email and password.
URL:
Method: POST
Request Parameters (JSON body)
email
(string): The email address for registration.password
(string): The password for the new account.platform
(string): The user's platform.device
(string): The user's device information.deviceID
(string): The user's device ID.ip
(string, optional): The user's IP address.userName
(string, optional): The user's username.
Responses
200 OK: Successful registration. Returns a
GetAllUserDataResult
object with new user data.400 Bad Request: Incorrect request parameters or email already in use. Possible messages: "INVALID_INPUT_DATA", "EMAIL_ALREADY_EXISTS", "REGISTRATION_FAILED".
Example Usage
Request:
Response:
Last updated
Was this helpful?