Home
  • 한국어
  • ENGLISH
Home
  • 한국어
  • ENGLISH
  • API 가이드
  • Withnox & Addnox

    • 소개
    • 인증
    • 유저
    • 기기
    • 베이스 스테이션
    • 분석 & 기록
    • 설문
    • OTA
  • Elexir 2.0

    • 소개
  • Elexir Legacy

    • 소개
    • 인증
    • 유저
    • 기기
  • LUX

    • 소개
    • 인증
    • 기기
    • 유저
  • ADT Device

    • 소개
    • 기기

유저

해당 페이지는 Elexir Legacy 프로젝트의 유저와 관련된 API를 설명해놓은 페이지입니다.

소개

Elexir Legacy 유저 API는 사용자 정보 불러오기, 업데이트 등과 연관된 자식 계정 관련 작업을 수행하는 기능입니다. API를 호출하기전에 인증 페이지를 읽어보시길 추천드립니다.

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

인증

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

Authorization: Bearer your_token_here

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

엔드포인트

이메일 중복 검사

회원가입전 이메일 중복 검사를 통해 회원가입 가능 여부를 조회합니다.

GET /api/v1/legacy/user/dup-check-email/{email}

요청 예시

GET /api/v1/legacy/user/dup-check-email/test@gmail.com HTTPS

응답 예시

200 OK
  • False는 중복된 이메일이 존재합니다.
  • True는 해당 이메일로 회원가입이 가능합니다.
True
ERROR

오류 응답

HTTP 상태 코드별로 API 상태 코드와 메시지를 제공합니다. 아래의 표를 참고하세요.

HTTP status codedetaildescription
500Internal Server Error서버 에러
{
    "detail": "Internal Server Error"
}

**전화번호 중복 검사 (Deprecated) **

회원가입전 전화번호 중복 검사를 통해 회원가입 가능 여부를 조회합니다.

GET /api/v1/legacy/user/dup-check-phone/{phone}

요청 예시

GET /api/v1/legacy/user/dup-check-phone/01012345678 HTTPS

응답 예시

200 OK
  • False는 중복된 전화번호가 존재합니다.
  • True는 해당 전화번호로 회원가입이 가능합니다.
True
ERROR

오류 응답

HTTP 상태 코드별로 API 상태 코드와 메시지를 제공합니다. 아래의 표를 참고하세요.

HTTP status codedetaildescription
500Internal Server Error서버 에러
{
    "detail": "Internal Server Error"
}

유저 정보 가져오기

로그인한 사용자의 정보를 불러옵니다. 응답에서 사용자가 비밀번호를 교체한지 3개월이 지낫는지, 정보 업데이트가 필요한지 여부를 Boolean 값으로 알려줍니다.

GET /api/v1/legacy/user/me

Headers

NameTypedescription
Authorization requiredBeareraccess_token

요청 예시

GET /api/v1/legacy/user/me HTTPS
Authorization: Bearer your_token_here

응답 예시

200 OK
{
    "email": "dev@gmail.com",
    "phone": "01012345678",
    "username": "tester123!",
    "relation": "S",
    "gender": "M",
    "birthdate": "1990-01-01",
    "gender_real": "",
    "birthdate_real": "",
    "social_google_id": "",
    "social_kakao_id": "",
    "social_naver_id": "",
    "social_apple_id": "",
    "is_marketing_agree": true,
    "is_push_agree": true,
    "country": "KR",
    "id": 2,
    "is_email_checked": true,
    "is_active": true,
    "regdate": "2025-04-07T04:41:13",
    "is_blocked": false,
    "block_type": "A",
    "block_reason": null,
    "need_to_pwd_chg": false,
    "last_pwd_changed_at": "2025-04-07T04:41:13"
}
ERROR

오류 응답

HTTP 상태 코드별로 API 상태 코드와 메시지를 제공합니다. 아래의 표를 참고하세요.

HTTP status codedetaildescription
401User is None가입된 유저 정보가 없습니다.
401User is Deleted회원탈퇴한 유저입니다.
{
    "detail": "User is None"
}

유저 푸시 토큰 설정

유저에게 푸시 알림을 보내기 위해 FCM 토큰을 서버에 저장합니다.

POST /api/v1/legacy/user/push/set-token

Headers

NameTypedescription
Authorization requiredBeareraccess_token

Body Parameters

NameTypedescription
token requiredstringFCM 토큰 값

요청 예시

POST /api/v1/legacy/user/push/set-token HTTPS
Authorization: Bearer your_token_here
{
    token: "your token"
}

응답 예시

200 OK
{
    "statusCode": 200, 
    "message": "Set push token successfully"
}
ERROR

오류 응답

HTTP 상태 코드별로 API 상태 코드와 메시지를 제공합니다. 아래의 표를 참고하세요.

HTTP status codedetaildescription
500Internal Server Error서버 에러
{
    "detail": "Internal Server Error"
}

유저 계정 탈퇴

유저의 계정을 비활성화하는 API입니다. 사용자 계정을 즉시 삭제하지 않고 is_active를 0으로 바꾸는 API입니다.

DELETE /api/v1/legacy/user

Headers

NameTypedescription
Authorization requiredBeareraccess_token

요청 예시

DELETE /api/v1/legacy/user HTTPS
Authorization: Bearer your_token_here
{
    token: "your token"
}

응답 예시

200 OK
{
    "statusCode": 200, 
    "message": "User deleted successfully"
}
ERROR

오류 응답

HTTP 상태 코드별로 API 상태 코드와 메시지를 제공합니다. 아래의 표를 참고하세요.

HTTP status codedetaildescription
409User delete failed서버 에러
{
    "detail": "User delete failed"
}
최근 수정:: 25. 4. 25. 오전 4:37
Contributors: Jeongtae Kim
Prev
인증
Next
기기