인증

해당 페이지는 Withnox & Addnox 프로젝트의 인증과 관련된 API를 설명해놓은 페이지입니다.

소개

Withnox & Addnox 인증 API는 회원가입, 소셜 회원가입, 로그인, SMS 번호 인증과 같은 인증 관련 작업을 수행하는 기능입니다.

API 흐름에 대한 시각적인 흐름도가 필요하다면 Figma API Flow 페이지를 참고해주세요.

인증

일부 인증 API는 인증 토큰을 필요로 합니다. 인증을 하기위해서 Authorization header 에 인증 토큰을 넣어서 API를 호출해주세요.

Authorization: Bearer your_token_here

your_token_here 에 인증 과정에서 획득한 access_token으로 대체해주세요.

엔드포인트

로그인

해당 이메일과 비밀번호로 로그인하는 API입니다.

Body Parameters

요청 예시

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

응답 예시

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

{
    "detail": "Password is invalid"
}

토큰 재발급

refresh_token을 이용해 token을 재발급 받는 API입니다. refresh_token의 유저 정보가 일치하지만 DB에 저장된 refresh_token과 일치하지 않을 경우 중복 로그인으로 판단하여 DB의 refresh_token을 삭제합니다. 프론트단에서는 401 Refresh token is not valid 오류에서 로그아웃으로 분기해야 합니다.

Body Parameters

요청 예시

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

응답 예시

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

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

SMS 인증 메세지 전송

해당 전화번호로 인증 문자를 발송하는 API입니다. 회원가입 뿐만 아니라 잃어버린 계정을 찾는데도 사용됩니다.

Body Parameters

요청 예시

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

응답 예시

  true

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

SMS 인증 번호 검증

SMS 인증 메세지로 전송된 6자리 번호를 검증하는 API 입니다.

Body Parameters

요청 예시

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

응답 예시

{
  "valid_token": "string"
}

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

이메일 회원가입

입력받은 정보를 통해 회원가입을 완료하는 API입니다. SMS 인증 검증을 통해 받은 valid_token을 확인해주세요.

Headers

Body Parameters

요청 예시

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

응답 예시

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

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

비밀번호 초기화

비밀번호 초기화를 위해 사용자의 이메일로 리셋 이메일을 보내주는 API입니다.

Body Parameters

요청 예시

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

응답 예시

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

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

아이디(계정) 찾기

아이디 또는 계정을 유저의 전화번호를 통해 찾는 API입니다. SMS 인증 메세지 전송 API 호출 후 불러야 합니다.

Body Parameters

요청 예시

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

응답 예시

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

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

소셜 로그인

소셜 로그인을 진행하는 API입니다. 파라미터로 소셜 provider를 전달해야합니다. 소셜 공급자별로 토큰이 다르기 때문에 Body Parameter 값 두개 중 하나만 보내도 됩니다.

403 에러는 소셜 회원가입을 진행하지 않은 유저이므로 소셜 회원가입으로 분기하시면 됩니다.

Parameters

Body Parameters

요청 예시

POST /api/v1/addnox/auth/social-signin/google
Content-Type: application/json
{
  "id_token": "string",
  "access_token": "string"
}

응답 예시

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

{
  "detail": "User is not valid, please sign up"
}

소셜 회원가입

사용자의 정보를 가지고 소셜 회원가입을 진행합니다. 일반 회원가입과 마찬가지로 SMS 번호 검증을 통한 valid_token이 필요합니다.

Headers

Body Parameters

요청 예시

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

응답 예시

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

{
  "detail": "Not authenticated"
}

공통 에러 처리

모든 엔드포인트에서 공통적으로 응답하는 에러코드입니다.

Error Response Example

• 401 Unauthorized: 토큰이 잘못되었습니다.

  {
    "detail": "Could not validate credentials" // 토큰이 잘못되었습니다.
  }
  
• 401 Unauthorized: 토큰이 만료되었습니다.

  {
    "detail": "Token is expired" // 토큰이 만료되었습니다.
  }
  
• 404 Not Found: 리소스를 찾을 수 없습니다. URI를 다시 확인해주세요.

  {
    "detail": "Resource not found"
  }
  
• 500 Internal Server Error: 서버 에러입니다.

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