API 개요

Base URL

https://api.lexq.io/v1

모든 API 엔드포인트는 HTTPS로 제공됩니다. HTTP 요청은 거부됩니다.

LexQ는 API Key 인증을 사용합니다. 모든 요청에 키를 포함하세요:

x-api-key: YOUR_API_KEY

API 키는 콘솔의 관리 → API 키에서 생성 및 관리합니다.

API 키는 조직의 정책 엔진에 대한 전체 접근 권한을 부여합니다. 클라이언트 코드나 공개 저장소에 노출하지 마세요.

모든 응답은 일관된 envelope 구조를 따릅니다:

{
  "result": "SUCCESS",
  "data": { ... },
  "message": null
}

최상위 필드는 result (값: "SUCCESS" 또는 "ERROR")입니다. success: true/false가 아닙니다. 통합 코드에서 항상 result === "SUCCESS"를 확인하세요.

{
  "result": "SUCCESS",
  "data": {
    "content": [ ... ],
    "totalElements": 42,
    "totalPages": 3,
    "pageNo": 0,
    "pageSize": 20
  }
}

pageNo (0부터 시작)와 pageSize 쿼리 파라미터로 페이지를 탐색합니다.