이메일 인증 API
개요
이메일 인증 API는 계정 가입 및 비밀번호 재설정을 위한 이메일 인증 코드 발송 및 검증 기능을 제공합니다.
주요기능
- 인증 코드 발송: 회원가입 또는 비밀번호 재설정을 위한 인증 코드 이메일 발송
- 인증 코드 검증: 발송된 인증 코드 검증
- 비밀번호 재설정 코드 검증: 비밀번호 재설정용 인증 코드 검증
[POST] /auth/email/verification-code/send - 인증 코드 발송
인증 코드 발송
회원가입 또는 비밀번호 재설정을 위한 인증 코드를 이메일로 발송합니다.
- HTTP Method:
POST - 인증: 불필요
Headers
| Header | Type | Description | Required |
|---|---|---|---|
| Content-Type | application/json | 요청 본문 타입 | ✔ |
Request Body
| 필드 | 타입 | 설명 | Required |
|---|---|---|---|
| string | 인증 코드를 받을 이메일 주소 | ✔ | |
| type | enum | 인증 코드 타입 (REGISTER, FIND_PASSWORD, RESET_PASSWORD) | ✔ |
Request Body Example
{
"email": "user@example.com",
"type": "REGISTER"
}
Responses
| Http Status Code | 설명 | Error Code(s) |
|---|---|---|
200 OK | 인증 코드 발송 성공 | - |
400 Bad Request | 잘못된 요청 | - |
200 OK - 성공
{
"success": true
}
| 필드 | 타입 | 설명 |
|---|---|---|
| success | boolean | 성공 여부 |
400 Bad Request - 잘못된 요청
예시: 유효하지 않은 이메일 형식
{
"status": 400,
"code": 40000,
"message": "Invalid email format",
"detail": ""
}
[POST] /auth/email/verification-code/verify - 인증 코드 검증
인증 코드 검증
이메일로 발송된 인증 코드를 검증합니다.
- HTTP Method:
POST - 인증: 불필요
Headers
| Header | Type | Description | Required |
|---|---|---|---|
| Content-Type | application/json | 요청 본문 타입 | ✔ |
Request Body
| 필드 | 타입 | 설명 | Required |
|---|---|---|---|
| string | 인증 코드를 받은 이메일 주소 | ✔ | |
| code | string | 6자리 인증 코드 | ✔ |
Request Body Example
{
"email": "user@example.com",
"code": "123456"
}
Responses
| Http Status Code | 설명 | Error Code(s) |
|---|---|---|
200 OK | 인증 코드 검증 성공 | - |
400 Bad Request | 잘못된 인증 코드 | - |
200 OK - 성공
{
"success": true
}
| 필드 | 타입 | 설명 |
|---|---|---|
| success | boolean | 성공 여부 |
400 Bad Request - 잘못된 요청
예시: 유효하지 않은 인증 코드
{
"status": 400,
"code": 40000,
"message": "Invalid verification code",
"detail": ""
}
[POST] /auth/email/verification-code/password-reset/verify - 비밀번호 재설정 코드 검증
비밀번호 재설정 코드 검증
비밀번호 재설정을 위한 인증 코드를 검증하고 비밀번호 재설정용 토큰을 발급합니다.
- HTTP Method:
POST - 인증: 불필요
Headers
| Header | Type | Description | Required |
|---|---|---|---|
| Content-Type | application/json | 요청 본문 타입 | ✔ |
Request Body
| 필드 | 타입 | 설명 | Required |
|---|---|---|---|
| string | 인증 코드를 받은 이메일 주소 | ✔ | |
| code | string | 6자리 인증 코드 | ✔ |
Request Body Example
{
"email": "user@example.com",
"code": "123456"
}
Responses
| Http Status Code | 설명 | Error Code(s) |
|---|---|---|
200 OK | 인증 코드 검증 성공 | - |
400 Bad Request | 잘못된 인증 코드 | - |
200 OK - 성공
{
"token": "password_reset_token"
}
| 필드 | 타입 | 설명 |
|---|---|---|
| token | string | 비밀번호 재설정용 토큰 |
400 Bad Request - 잘못된 요청
예시: 유효하지 않은 인증 코드
{
"status": 400,
"code": 40000,
"message": "Invalid verification code",
"detail": ""
}