Perry
  • Integrated API Spec
  • Page 2
  • integrated API Spec
    • /account
    • /character
    • /admin
      • /server
      • /character
      • /map
      • /account
      • /world
        • /world/:worldId
Powered by GitBook
On this page
  • /register
  • /login
  • /info
  • /info
  • /delete
  • /password
  1. integrated API Spec

/account

/register

POST /account/register

Register a new account (Finished)

Request Body

Name
Type
Description

email*

String

Email address use for login and password recovery for future

password*

String

Password to login

birthday*

String

Birthday. Need to pass in "yyyy-MM-dd" format. Mandatory.

female*

Boolean

Gender selection

socialNumber*

String

Social number in Korea. DO NOT USE REAL NUMBER. Only use for confirm character deletion.

{
    success: true,
    message: "SUCCESS"
}
{
    success: false,
    message: "ALREADY_REGISTERED_IP" // If IP already used to register
    message: "ALREADY_REGISTERED_EMAIL" // If Email is already used
    message: "INTERNAL_ERROR" // If failed but server's fault
}

/login

POST /account/login

Login to Web API and retrieve access token (Finished)

Request Body

Name
Type
Description

email

String

Email address to login in game client

password

String

Password to login in game client

{
    success: true,
    message: "SUCCESS",
    data: {
        token: "JWT_TOKEN" // Token
    }
}
{
    success: false,
    message: "INCORRECT_EMAIL_PASSWORD"
}
{
    success: false,
    message: "INTERNAL_ERROR"
}

/info

GET /account/info

Get information about account

Headers

Name
Type
Description

Bearer*

String

Token

{
    success: true,
    message: "SUCCESS"
    data: {
        name: String,
        nxCredit: Int,
        mPoint: Int,
        lastLogin: Long,
        createdAt: Long,
        banned: Boolean,
        banReason: String,
        female: Boolean,
        socialNumber: Int,
        registeredIP: String
    }
}
{
    success: false,
    message: "INTERNAL_ERROR"
}

/info

PUT /account/info

Headers

Name
Type
Description

Bearer*

String

Token

Request Body

Name
Type
Description

female

Boolean

Is for mark account as female?

socialNumber

Integer

Social number for delete character

{
    // Response
}
{
    // Response
}

/delete

DELETE /account/delete

Delete account. While performing delete, connected client with account will be disconnect at once and also delete characters and related data, connected to this account

Headers

Name
Type
Description

Bearer*

String

Token

{
    // Response
}
{
    // Response
}

/password

PUT /account/password

To change account's password

Headers

Name
Type
Description

Bearer

String

token

Request Body

Name
Type
Description

name*

String

Login name

oldPassword*

String

Old password to verify

newPassword*

String

New password going to use

newPasswordCheck*

String

New password again

{
    // Response
}
{
    // Response
}
PreviousPage 2Next/character

Last updated 1 year ago