[BackEnd] 초대 비즈니스 로직 설계

[sooah-0208]

확정안

API 명세서

---

초대 관련 API 명세서

1. 초대 페이지 렌더링 (GET)

Description: invite_id를 확인하여 회원가입 폼 HTML 페이지를 반환합니다.

항목	내용
Method	GET
URL	/invite/{invite_id}
Auth	N/A

Request Parameters

1. Path Parameters

Model명	형식	필수여부	설명
invite_id	str	Required	초대 고유 식별자 (Redis 조회용)

Response Body (HTML)

• 성공 시 React 기반의 회원가입 폼 HTML 반환.

---

2. 초대 데이터 복호화 및 조회 (POST)

Description: invite_id를 통해 Redis에서 토큰을 가져와 복호화한 후, 이메일과 회사명을 반환합니다.

항목	내용
Method	POST
URL	/invite/{invite_id}
Auth	-

Request Parameters

1. Path Parameters

Model명	형식	필수여부	설명
invite_id	str	Required	초대 고유 식별자

Response Body (JSON)

성공

{
  "status": true,
  "message":""
  "data": {
    "companyName": "A회사",
    "email": "test@gmail.com",
    "name": "",
    "password": ""
  }
}

실패

{
  "status": false,
}

---

3. 초대 기반 회원가입 완료 (PUT)

Description: 사용자가 입력한 추가 정보(이름, 비밀번호 등)를 받아 회원가입을 완료합니다.

항목	내용
Method	PUT
URL	/invite/{invite_id}
Auth	-

Request Parameters

1. Path Parameters

Model명	형식	필수여부	설명
invite_id	str	Required	초대 고유 식별자

2. Request Body (JSON)

Model명	형식	필수여부	설명
companyName	str	Required	회사명
email	str	Required	이메일 주소
name	str	Required	사용자 이름
password	str	Required	비밀번호

Response Body (JSON)

성공

{
  "status": true,
  "message": "회원가입이 완료되었습니다."
}

실패

{
  "status": false,
}

---

4. 컨설턴트 담당자 초대 (POST)

Description: 컨설턴트 담당자를 초대합니다.

항목	내용
Method	POST
URL	/inviteConsultant
Auth	-

Request Parameters

1. Request Body (JSON)

Model명	형식	필수여부	설명
emailList	[EmailStr]	Required	초대할 담당자 email 리스트
issueList	[str]	Required	선택된 항목(이슈) 목록
role	int	Required	ROLE Table의 id

Response Body (JSON)

성공

{
  "status": true,
  "message": "초대가 완료되었습니다.",
  "data": {}
}

실패

{
  "status": false,
  "message": "초대 중 오류가 발생했습니다.",
  "data": {}
}

---

영향 범위

FE @x2bjvhmmwg-gif / BE / 문서 @frankie516c

담당자

@choiyc05 @sooah-0208 @choegayoung

결정일

2026-05-06