Backend API specification : Login/Logout/Register/Activate

[ryanking13]

Request List

• Login
• Logout
• Register
• Activate

Login

Request

POST /auth/login

parameter:

Parameter	Description	Example
username	username	guest
password	password	monkey

Response

On success:

{
  "resultcode": 200,
  "success": true,
  "message": "Login successful",
  "data": []
}

On fail:

# when the user is already logged in
{
  "resultcode": 400,
  "success": false,
  "message": "Already signed in",
  "data": []
}

# when parameters are not fully given
{
  "resultcode": 400,
  "success": false,
  "message": "Parameters not given",
  "data": []
}

# when email is not verified
{
  "resultcode": 401,
  "success": false,
  "message": "No email verification",
  "data": []
}

# when username/password is wrong
{
  "resultcode": 401,
  "success": false,
  "message": "Wrong info",
  "data": []
}

# on DB error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}

Logout

Request

POST /auth/logout

parameter:

• None

Response

On success:

# redirected to home

On fail:

# On DB Error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}

# If not logged in
{
  "resultcode": 400,
  "success": false,
  "message": "Not logged in",
  "data": []
}

Register

Request

POST /auth/register

parameter:

Parameter	Description	Example
username	username	guest
password	password	monkey
email	email address	a@gmail.com
nickname	nickname	haXor
is_club_member	registering as a Guardian member	1
phone	phone number	01012341234
real_name	real name of user	홍길동

• phone, real_name is not needed if is_club_member is 0.

Response

On success:

{
  "resultcode": 200,
  "success": true,
  "message": "Successfully send mail",
  "data": []
}

On fail:

# when parameters are not fully given
{
  "resultcode": 400,
  "success": false,
  "message": "Parameters not given",
  "data": []
}

# when phone, real_name is not given (for Guardian memeber)
{
  "resultcode": 400,
  "success": false,
  "message": "Parameters not enough",
  "data": []
}

# when username is duplicated
{
  "resultcode": 400,
  "success": false,
  "message": "Username exists",
  "data": []
}

# on DB error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}

Activate

email verification

Request

GET /auth/activate

parameter:

Parameter	Description	Example
username	username	guest
token	email token	deadbeafabcd1234....

Response

On success:

{
  "resultcode": 200,
  "success": true,
  "message": "successfully verified",
  "data": []
}

On fail:

# when token is invalid
{
  "resultcode": 401,
  "success": false,
  "message": "Not valid token",
  "data": []
}

# on DB Error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}