FAQ 관리

FAQ 수정

put

기능설명

• FAQ 관리 수정 화면에서 저장 시 사용되는 api 입니다.

---

상세설명

• FAQ번호, 제목, FAQ대분류코드, FAQ중분류코드, 게시여부, 정렬순서, 상단고정여부, pc공지내용, mo공지내용은 필수입니다.

---

수정번호

• Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FAQ 관리 등록, 수정 요청 DTO

faqLgrpCdstringOptional

FAQ대분류코드(CM014)

Example: 20

faqMgrpCdstringOptional

FAQ대분류코드(CM015)

Example: 04

titlestringOptional

제목

Example: 배송 기간은 보통 얼마나 걸리나요?

bbYnstringOptional

게시여부

Example: Y

faqNostringOptional

FAQ 번호

Example: 10001

sortSeqinteger · int32Optional

정렬순서

Example: 1

uprFixYnstringOptional

상단고정여부

Example: Y

pcNtcContstringOptional

PC공지내용

Example: 공지내용

moNtcContstringOptional

MO공지내용

Example: 공지내용

startDatestring · dateOptional

등록일 시작일시

Example: 2023-01-01

endDatestring · dateOptional

등록일 종료일시

Example: 2023-01-01

dateSelectstringOptional

선택한 기간

Example: all_day

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

put

/v2/system/faqMgmt/modifyFaqInfo

HTTPcURLJavaScriptPython

PUT /api/bo/v2/system/faqMgmt/modifyFaqInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "faqLgrpCd": 20,
  "faqMgrpCd": "04",
  "title": "배송 기간은 보통 얼마나 걸리나요?",
  "bbYn": "Y",
  "faqNo": 10001,
  "sortSeq": 1,
  "uprFixYn": "Y",
  "pcNtcCont": "공지내용",
  "moNtcCont": "공지내용",
  "startDate": "2023-01-01",
  "endDate": "2023-01-01",
  "dateSelect": "all_day"
}

text

FAQ 다건 수정

post

기능설명

• FAQ 관리 화면 내에서 직접 수정하는 경우에 사용되는 api 입니다.

---

상세설명

• FAQ 번호는 필수입니다.

• 게시여부, 정렬순서를 수정할 수 있습니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

FAQ 관리 등록, 수정 요청 DTO

faqLgrpCdstringOptional

FAQ대분류코드(CM014)

Example: 20

faqMgrpCdstringOptional

FAQ대분류코드(CM015)

Example: 04

titlestringOptional

제목

Example: 배송 기간은 보통 얼마나 걸리나요?

bbYnstringOptional

게시여부

Example: Y

faqNostringOptional

FAQ 번호

Example: 10001

sortSeqinteger · int32Optional

정렬순서

Example: 1

uprFixYnstringOptional

상단고정여부

Example: Y

pcNtcContstringOptional

PC공지내용

Example: 공지내용

moNtcContstringOptional

MO공지내용

Example: 공지내용

startDatestring · dateOptional

등록일 시작일시

Example: 2023-01-01

endDatestring · dateOptional

등록일 종료일시

Example: 2023-01-01

dateSelectstringOptional

선택한 기간

Example: all_day

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v2/system/faqMgmt/saveFaqList

HTTPcURLJavaScriptPython

POST /api/bo/v2/system/faqMgmt/saveFaqList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 270

[
  {
    "faqLgrpCd": 20,
    "faqMgrpCd": "04",
    "title": "배송 기간은 보통 얼마나 걸리나요?",
    "bbYn": "Y",
    "faqNo": 10001,
    "sortSeq": 1,
    "uprFixYn": "Y",
    "pcNtcCont": "공지내용",
    "moNtcCont": "공지내용",
    "startDate": "2023-01-01",
    "endDate": "2023-01-01",
    "dateSelect": "all_day"
  }
]

text

FAQ 다국어 정보 등록, 수정

post

기능설명

• FAQ 다국어 정보를 등록, 수정합니다.

---

상세설명

• 넘어온 langCd의 다국어 정보를 등록, 수정합니다.

• 등록 시 필수 파라미터는 언어코드, pc내용, mo내용 입니다.

• 수정 시 필수 파라미터는 언어코드, pc내용, mo내용, FAQ번호 입니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FAQ 관리 다국어 등록, 수정 요청 DTO

faqNostringOptional

FAQ 번호

Example: 10001

titlestringOptional

제목

Example: 배송 기간은 보통 얼마나 걸리나요?

pcNtcContstringOptional

PC공지내용

Example: 공지내용

moNtcContstringOptional

MO공지내용

Example: 공지내용

dataLangCdstringOptional

다국어 언어코드

Example: en

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v2/system/faqMgmt/saveFaqInfoMl

HTTPcURLJavaScriptPython

POST /api/bo/v2/system/faqMgmt/saveFaqInfoMl HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "faqNo": 10001,
  "title": "배송 기간은 보통 얼마나 걸리나요?",
  "pcNtcCont": "공지내용",
  "moNtcCont": "공지내용",
  "dataLangCd": "en"
}

text

FAQ 등록

post

기능설명

• FAQ 관리 등록 화면에서 저장 시 사용되는 api 입니다.

---

상세설명

• 제목, FAQ대분류코드, FAQ중분류코드, 게시여부, 정렬순서, 상단고정여부, pc공지내용, mo공지내용은 필수입니다.

• 기본세팅언어코드 기준으로 등록합니다.

---

수정번호

• Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

FAQ 관리 등록, 수정 요청 DTO

faqLgrpCdstringOptional

FAQ대분류코드(CM014)

Example: 20

faqMgrpCdstringOptional

FAQ대분류코드(CM015)

Example: 04

titlestringOptional

제목

Example: 배송 기간은 보통 얼마나 걸리나요?

bbYnstringOptional

게시여부

Example: Y

faqNostringOptional

FAQ 번호

Example: 10001

sortSeqinteger · int32Optional

정렬순서

Example: 1

uprFixYnstringOptional

상단고정여부

Example: Y

pcNtcContstringOptional

PC공지내용

Example: 공지내용

moNtcContstringOptional

MO공지내용

Example: 공지내용

startDatestring · dateOptional

등록일 시작일시

Example: 2023-01-01

endDatestring · dateOptional

등록일 종료일시

Example: 2023-01-01

dateSelectstringOptional

선택한 기간

Example: all_day

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post

/v2/system/faqMgmt/registFaqInfo

HTTPcURLJavaScriptPython

POST /api/bo/v2/system/faqMgmt/registFaqInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "faqLgrpCd": 20,
  "faqMgrpCd": "04",
  "title": "배송 기간은 보통 얼마나 걸리나요?",
  "bbYn": "Y",
  "faqNo": 10001,
  "sortSeq": 1,
  "uprFixYn": "Y",
  "pcNtcCont": "공지내용",
  "moNtcCont": "공지내용",
  "startDate": "2023-01-01",
  "endDate": "2023-01-01",
  "dateSelect": "all_day"
}

text

FAQ 중복여부 확인

get

기능설명

• FAQ 관리의 대분류, 중분류, FAQ번호에 대한 중복여부를 확인합니다.

---

상세설명

• FAQ 관리의 대분류, 중분류, FAQ번호에 대한 중복여부를 확인합니다.

• 중복된 데이터가 존재하면 true를 반환하고, 아니면 false를 반환합니다.

---

수정번호

• Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Responses

200

성공

*/*

booleanOptional

900

업무처리 오류 내용

*/*

get

/v2/system/faqMgmt/getFaqOverLapCheck

HTTPcURLJavaScriptPython

GET /api/bo/v2/system/faqMgmt/getFaqOverLapCheck?faqRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

FAQ 목록 조회

get

기능설명

• 조건에 맞는 FAQ 목록을 조회합니다.

---

상세설명

• 조건에 맞는 FAQ 목록을 조회합니다.

• 쿠키 값의 dataLangCd 기준으로 조회합니다.

• 대분류, 중분류를 넣으면 해당 분류에 맞는 목록을 조회합니다.

---

수정번호

• Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

faqLgrpCdstringOptional

FAQ 대분류코드(CM014)

faqMgrpCdstringOptional

FAQ 중분류코드(CM015)

titlestringOptional

제목

bbYnstringOptional

게시여부

siteNostringOptional

사이트번호

pageIdxstringRequired

현재 페이지

Example: 1

rowsPerPagestringRequired

페이지 당 row

Example: 10

startDateLocalDateRequired

조회 시작일

endDateLocalDateRequired

조회 종료일

dateSelectstringRequired

선택한 기간

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get

/v2/system/faqMgmt/getFaqList

HTTPcURLJavaScriptPython

GET /api/bo/v2/system/faqMgmt/getFaqList?faqRequest=[object+Object]&pageIdx=text&rowsPerPage=text&startDate=null&endDate=null&dateSelect=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "faqNo": "text",
      "faqLgrpCd": "text",
      "faqMgrpCd": "text",
      "uprFixYn": "text",
      "sortSeq": 1,
      "bbYn": "text",
      "title": "text",
      "titleMl": "text",
      "pcNtcCont": "text",
      "moNtcCont": "text",
      "qryCnt": 1,
      "siteNm": "text"
    }
  ]
}

FAQ 정보 다국어 조회

get

기능설명

• 선택한 FAQ 에 대한 다국어 정보를 조회합니다.

---

상세설명

• FAQ번호는 필수입니다.

• 선택한 FAQ 에 대한 다국어 정보를 조회합니다.

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

faqNostringOptional

FAQ 번호

Responses

200

성공

*/*

faqNostringOptional

langCdstringOptional

titlestringOptional

titleMlstringOptional

pcNtcContstringOptional

pcNtcContMlstringOptional

moNtcContstringOptional

moNtcContMlstringOptional

900

업무처리 오류 내용

*/*

get

/v2/system/faqMgmt/getFaqInfoMl

HTTPcURLJavaScriptPython

GET /api/bo/v2/system/faqMgmt/getFaqInfoMl?faqMlRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "faqNo": "text",
  "langCd": "text",
  "title": "text",
  "titleMl": "text",
  "pcNtcCont": "text",
  "pcNtcContMl": "text",
  "moNtcCont": "text",
  "moNtcContMl": "text"
}

FAQ 단건 조회

get

기능설명

• FAQ 공지번호에 대한 FAQ 정보를 조회합니다.

---

상세설명

• 쿠기 값에 세팅된 dataLangCd 기준으로 조회합니다.

• FAQ 번호는 필수입니다.

---

수정번호

• Release v2.00_240425 : 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

Authorizations

accessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

faqNostringOptional

FAQ 번호

Responses

200

성공

*/*

faqNostringOptional

faqLgrpCdstringOptional

faqMgrpCdstringOptional

uprFixYnstringOptional

sortSeqinteger · int32Optional

bbYnstringOptional

titlestringOptional

titleMlstringOptional

pcNtcContstringOptional

moNtcContstringOptional

qryCntinteger · int32Optional

siteNmstringOptional

900

업무처리 오류 내용

*/*

get

/v2/system/faqMgmt/getFaqDetail

HTTPcURLJavaScriptPython

GET /api/bo/v2/system/faqMgmt/getFaqDetail?faqRequest=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "faqNo": "text",
  "faqLgrpCd": "text",
  "faqMgrpCd": "text",
  "uprFixYn": "text",
  "sortSeq": 1,
  "bbYn": "text",
  "title": "text",
  "titleMl": "text",
  "pcNtcCont": "text",
  "moNtcCont": "text",
  "qryCnt": 1,
  "siteNm": "text"
}