Skip to content
6suhyeon edited this page Feb 15, 2025 · 2 revisions

API Documentation

Endpoints

1. Get FAQ

- FAQ 전체 조회

  • EndPoint: /FAQ

  • Method: GET

  • Request: None

  • Response:

    • success: Boolean
    • message: String
    • FAQList (faqId, question, answer)
      • faqId: UUID (unique)
      • question: String
      • answer: String
  • Response Success Example:

{
    "success": true,
    "message": "FAQ 전체조회 성공",
    "FAQList": [
        {
            "faqId": "4f7d22d6-bd9d-48c2-8885-6debf58c3cf2",
            "question": "Q2. 카메라로 얼굴을 인식하는데 도용에 대해서는 괜찮나요?",
            "answer": "22얼굴 인식 기술은 매우 편리하지만, 도용에 대한 걱정이 있으실 수 있습니다. 이를 방지하기 위해 저희는 사진이나 영상으로는 인증이 되지 않도록 3D 얼굴 인식이나 심도 카메라 같은 안전한 기술을 사용하고 있습니다. 또한, 얼굴 인식 외에도 비밀번호나 OTP 같은 추가 인증 단계를 적용해 보안을 더욱 강화하고 있습니다. 고객님의 정보는 법적으로 안전하게 보호되며, 안심하고 서비스를 이용하실 수 있도록 최선을 다하고 있습니다. "
        },
        {
            "faqId": "c6f6e776-c808-4d75-b416-9239a15cbb22",
            "question": "Q2. 카메라로 얼굴을 인식하는데 도용에 대해서는 괜찮나요?",
            "answer": "22얼굴 인식 기술은 매우 편리하지만, 도용에 대한 걱정이 있으실 수 있습니다. 이를 방지하기 위해 저희는 사진이나 영상으로는 인증이 되지 않도록 3D 얼굴 인식이나 심도 카메라 같은 안전한 기술을 사용하고 있습니다. 또한, 얼굴 인식 외에도 비밀번호나 OTP 같은 추가 인증 단계를 적용해 보안을 더욱 강화하고 있습니다. 고객님의 정보는 법적으로 안전하게 보호되며, 안심하고 서비스를 이용하실 수 있도록 최선을 다하고 있습니다. "
        }
    ]
}
  • Response failure Example:
{
    "success" : false,
    "message" : "FAQ 전체조회 실패",
    "FAQList": null
}

2.Save FAQ

- 키워드 저장

  • Endpoint: /FAQ

  • Method: POST

  • Request:

    • question: String
    • keyword: String
  • Request Example:

{
    "question" : "Q2. 카메라로 얼굴을 인식하는데 도용에 대해서는 괜찮나요?",
    "answer" : "22얼굴 인식 기술은 매우 편리하지만, 도용에 대한 걱정이 있으실 수 있습니다. 이를 방지하기 위해 저희는 사진이나 영상으로는 인증이 되지 않도록 3D 얼굴 인식이나 심도 카메라 같은 안전한 기술을 사용하고 있습니다. 또한, 얼굴 인식 외에도 비밀번호나 OTP 같은 추가 인증 단계를 적용해 보안을 더욱 강화하고 있습니다. 고객님의 정보는 법적으로 안전하게 보호되며, 안심하고 서비스를 이용하실 수 있도록 최선을 다하고 있습니다. "
}
  • Response:
    • success: Boolean
    • message: String
    • FAQId: UUID (unique)
  • Response Success Example:
{
    "success": true,
    "FAQId": "6cd7d390-007d-4abb-84db-388c2d3474c6",
    "message": "FAQ 저장 성공"
}
  • Response Fail Example:
{
    "FAQId": null,
    "success": false,
    "message": "FAQ 저장 실패"
}

Clone this wiki locally