Feature / 1차 API 요청 사항 정리 / CMS

[ryxxn]

Description

CMS에서 사용할 API 요청 사항이에요.

---

CMS에서는 사이트 관리, 문의 관리, 기타 설정 기능이 필요해요.

따라서

1. 사이트 관리

1.1 사이트 관리

고객은 로고(Favicon), 사이트 이름, 커스텀 도메인, Google Analytics 네 개의 정보를 추가/수정 할 수 있어야 해요.

PATCH /cms/site/info

Request Body

{
 
}

Response Body

{
 
}

---

2. 문의 관리 (email 연동)

2.1 문의 생성

홈페이지에서 문의를 생성하는 기능이 있어야 해요.

POST /customer/inquiry

Request Body

상담을 진행하지 않고도 고객을 바로 생성하는 경우가 있을 수 있어 상담 ID(consultantId)는 Nullable이어야 해요.

{
  "inquirer": "김도훈",
  "title": "홈페이지에 문제가 있어요",
  "content: "유저 생성이 안됩니다. 조속한 해결 바랍니다."
}

---

2.2 전체 문의 조회(리스트)

CMS에서 전체 문의 목록을 조회하는 기능이 있어야 해요.

GET /cms/inquiry?page=1&size=6

Response Body

순번에 따라 페이지네이션이 적용된 문의 목록이 필요해요.

{
   "inquiries" : [
      {
          "id":1, 
          "order": 1,
          "inquiryNumber": "2025010101",
          "inquirer": "김도훈",
          "title": "홈페이지에 문제가 있어요",
          "status": "UNPROCESSED", // enum (UNPROCESSED - 미처리), (COMPLETED - 처리완료)
          "createAt": "2025-09-03T16:47:06.943Z",
      },
   ]
}

---

2.3 문의 상세 조회

CMS에서 문의 상세 정보를 조회하는 기능이 있어야 해요.

GET /cms/inquiry/{inquiryId}

Response Body

조회 요청한 문의의 상세 정보가 필요해요.

{
   "inquiry" : {
          "id":1, 
          "order": 1,
          "inquiryNumber": "2025010101",
          "inquirer": "김도훈",
          "title": "홈페이지에 문제가 있어요",
          "content: "유저 생성이 안됩니다. 조속한 해결 바랍니다.",
          "reply": null,
          "status": "UNPROCESSED", // enum (UNPROCESSED - 미처리), (COMPLETED - 처리완료)
          "createAt": "2025-09-03T16:47:06.943Z",
     }
}

---

2.4 문의 처리완료

CMS에서 문의에 대한 답변을 저장하고 처리 완료로 바꾸는 기능이 필요해요.

PATCH /cms/inquiry/{inquiryId}

Request Body

조회 요청한 문의의 상세 정보가 필요해요.

{
   "inquiry" : {
          "reply":  "잘 처리됐습니다."
     }
}

Response Body

조회 요청한 문의의 상세 정보가 필요해요.

{
}

---

3. 설정(보류)

3.1 결제 설정

Request Body

{
 
}

Response Body

{
 
}

---