API DOCS ‐ Main User

Main Uesr API Documentation

1. Login Main User

• Description: 사용자 로그인을 위한 API입니다. 전화번호와 이름을 통해 기존 사용자 여부를 확인하고, UUID를 반환합니다.
• Endpoint: /main/user
• Method: GET
• Request Parameters:
  • phone-num: String - 사용자의 전화번호
  • main-user-name: String - 사용자의 이름
• Response:
  • success: Boolean
  • message: String
  • mainUserId: UUID (로그인 성공 시 반환)

Response Success Example:

{
  "success": true,
  "message": "로그인 성공",
  "mainUserId": "94e73952-e74e-4f09-89dc-33f09c80ae32"
}

Response Failure Example:

{
  "success": false,
  "message": "로그인 실패",
  "mainUserId": null
}

---

2. Save Main User

• Description: 사용자 정보를 저장하는 API입니다.
• Endpoint: /main/user
• Method: POST
• Request Body:

{
  "mainUserName": "홍길동",
  "phoneNum": "01012345678",
  "studentNum": "20231234",
  "authorizationCode": "123456"
}

• Response:
  • success: Boolean
  • message: String
  • mainUserId: UUID (저장 성공 시 반환)

Response Success Example:

{
  "success": true,
  "message": "사용자 정보 저장 성공",
  "mainUserId": "dfd4e27c-1881-41a9-8e7f-453b0cf679aa"
}

Response Failure Example:

{
  "success": false,
  "message": "사용자 정보 저장 실패",
  "mainUserId": null
}

---

3. Send Authorization Code

• Description: 사용자에게 인증번호를 문자로 전송하는 API입니다.
• Endpoint: /main/user/authorization
• Method: POST
• Request Body:

{
  "mainUserName": "홍길동",
  "phoneNum": "01012345678",
  "studentNum": "20231234",
  "authorizationCode": "123456"
}

• Response:
  • success: Boolean
  • message: String
  • mainUserId: UUID (전송 성공 시 반환)

Response Success Example:

{
  "success": true,
  "message": "인증번호 전송 성공",
  "mainUserId": "dfd4e27c-1881-41a9-8e7f-453b0cf679aa"
}

Response Failure Example:

{
  "success": false,
  "message": "인증번호 전송 실패",
  "mainUserId": null
}

---