Authentication

This page describes the APIs related to authentication for the LUX project.

Introduction

The LUX Authentication API provides functions to perform authentication-related tasks such as user registration (sign-up), social media sign-up, login, and SMS number verification.

Authentication

Some authentication APIs require an authentication token. Please include the authentication token in the Authorization header to make authenticated API requests.

Authorization: Bearer your_token_here

Replace your_token_here with the access token obtained during the authentication process.

Endpoints

Signin

This API allows a user to log in with the provided email and password.

Body Parameters

Request Example

POST /api/v1/lux/auth/email/signin
Content-Type: application/x-www-form-urlencoded
{
  "username ": "string",
  "password ": "string"
}

Response Example

{
  "access_token": "string",
  "expires_in": 0,
  "refresh_token": "string",
  "refresh_expires_in": 0,
  "id": 0,
  "token_type": "string"
}

{
    "detail": "Password is invalid"
}

Token Refresh

This is an API that reissues a token using a refresh_token. If the user information in the refresh_token matches, but the token itself does not match the refresh_token stored in the DB (database), it is considered a duplicate login, and the refresh_token in the DB is deleted. On the front-end, a "401 Refresh token is not valid" error should be handled by branching to a logout process.

Body Parameters

Request Example

POST /api/v1/lux/auth/refresh-token
Content-Type: application/json
{
  "refresh_token": "string"
}

Response Example

{
    "access_token": "access_token",
    "expires_in": 900, // 15 minutes 
    "refresh_token": "new_refresh_token",
    "refresh_expires_in": 1209600,  // 2 weeks
    "id": "uuid",
    "token_type": "bearer",
}

{
    "detail": "Refresh token is not valid"
}

Send SMS Verification Message

This API sends an SMS verification message to the provided phone number. It is used not only for signup but also to help users retrieve lost accounts.

Body Parameters

Request Example

POST /api/v1/lux/auth/send-sms-auth
Content-Type: application/json
{
  "phone": "+1012345678"
}

Response Example

  true

{
  "detail": "Phone number is invalid"
}

Verify SMS Verification Code

This API verifies the SMS verification code sent to the user's phone number.

Body Parameters

Request Example

POST /api/v1/lux/auth/phone-number-validation
Content-Type: application/json
{
  "phone": "+1012345678",
  "validnum": "123456"
}

Response Example

{
  "valid_token": "string"
}

{
  "detail": "Validation code is expired"
}

Email Signup

This API allows a user to complete the signup process with an email and password. Include the access_token in the Authorization header for authentication.

Headers

Body Parameters

Request Example

POST /api/v1/lux/auth/email/signup
Authorization: Bearer valid_token_here
Content-Type: application/json
{
  "email": "string",
  "password": "string",
  "first_name": "string",
  "last_name": "",
  "birthdate": "string",
  "gender": "string",
  "phone": "string",
  "register_type": "string",
  "is_push_agree": true,
  "is_marketing_agree": true,
  "national_code": "string"
}

Response Example

{
  "access_token": "string",
  "expires_in": 0,
  "refresh_token": "string",
  "refresh_expires_in": 0,
  "id": 0,
  "token_type": "string"
}

{
  "detail": "Email is not valid"
}

Password Reset

This API allows a user to reset their password using their email.

Body Parameters

Request Example

POST /api/v1/lux/auth/phone-number-validation
Content-Type: application/json
{
  "email": "string"
}

Response Example

{
  "statusCode": 200,
  "message": "User reset password email send successfully"
}

{
  "detail": "User id is not found"
}

Account Recovery (Find Account)

This API allows a user to retrieve their account ID (email) using their registered phone number and a verification code sent via SMS.

Body Parameters

Request Example

POST /api/v1/lux/auth/phone-number-validation
Content-Type: application/json
{
  "phone": "string",
  "validnum": "string"
}

Response Example

{
  "email": "your@email.com",
  "provider": "naver"
}

{
  "detail": "Validation code is expired"
}

Common Error Handling

These are error codes that are commonly returned by all endpoints.

Error Response Example

• 401 Unauthorized: The token is invalid.

  {
    "detail": "Could not validate credentials" // The token is invalid
  }
  
• 401 Unauthorized: The token has expired.

  {
    "detail": "Token is expired" // The token has expired.
  }
  
• 404 Not Found: The resource cannot be found. Please check the URI again.

  {
    "detail": "Resource not found"
  }
  
• 500 Internal Server Error: This is a server error.

  {
    "detail": "Internal server error. Please try again later."
  }