Ready Player Me Account
Ready Player Me accounts are accounts of users who created an account at https://readyplayer.me or a subdomain (e.g. https://yoursubdomain.readyplayer.me). Those users want to log in with their credentials and reuse their existing avatars and unlocked assets in your game or app.
Logging user in
First, you send a code to the user's email linked with Ready Player Me:
Initialize the auth process
POST https://[your-application-subdomain].readyplayer.me/api/auth/start
Start the authentication process by sending a code to the user's email.
Request Body
| Name | Type | Description |
|---|---|---|
email* | String | Email of the user |
authType* | String | This needs to be set to "code" |
The user then uses this code to log in, which returns a user token:
Log user into the Ready Player Me account
POST https://[your-application-subdomain].readyplayer.me/api/auth/login
Request Body
| Name | Type | Description |
|---|---|---|
code* | String | Pass the code, that the user entered in some input field in your application |
This will return you the current state of the user.
Refreshing user token
The previous login response returned the user token and the refresh token. The user token lasts for 15 minutes. After that, you will have to refresh your token to the new token. The following request will return you the new token:
Refresh user token
POST https://[your-application-subdomain].readyplayer.me/api/auth/refresh
Request Body
| Name | Type | Description |
|---|---|---|
token* | String | Token from user login call |
refreshToken* | String | Refresh token from user login call |
Start managing your user
Token enables you to start doing the following actions with your user
Last updated