본문으로 이동
시작하기
KLIC/리소스/JSON API
KLIC / RESOURCES

JSON API

공개 읽기 API, 스키마와 요청 제한

TOOLKIT 0.0.1Markdown ↓

공개 읽기 엔드포인트

GET 경로Operation ID
/api/v1/searchsearchItems
/api/v1/design-system.jsongetDesignSystem
/api/v1/healthgetHealth
/api/v1/registry.jsongetRegistry
/api/v1/motions.jsonlistMotions
/api/v1/motions/{id}.jsongetMotion
/api/v1/capabilities.jsongetCapabilities
/api/v1/tools.jsongetToolSchemas
/api/v1/items/{kind}/{id}.jsongetItem
/api/v1/themes.jsonlistThemes
/api/v1/themes/{id}.jsongetTheme
/api/v1/theme-plan/{id}getThemeInstallPlan
/api/v1/theme-bundles/{id}/{profile}/{material}/{mode}.jsongetThemeBundle

전체 OpenAPI 경로와 응답 스키마를 내려받아 확인할 수 있습니다.

OpenAPI
https://design.klic.co.kr/api/v1/openapi.json

테마 API 요청

Terminal
curl -f https://design.klic.co.kr/api/v1/themes.json
curl -f https://design.klic.co.kr/api/v1/themes/paper.json
curl -f 'https://design.klic.co.kr/api/v1/theme-plan/paper?profile=studio&material=glass&mode=system'
curl -f https://design.klic.co.kr/api/v1/theme-bundles/paper/studio/glass/system.json

theme-plan은 검증한 컨텍스트의 정적 manifest 경로와 CLI 명령을 반환합니다. manifest의 파일 크기와 SHA-256을 검증하는 실제 로컬 저장은 CLI theme add에서만 수행합니다.

모션 카탈로그 API

Terminal
curl -f 'https://design.klic.co.kr/api/v1/motions.json?category=entrance&limit=5'
curl -f https://design.klic.co.kr/api/v1/motions/fade-slide.json

모션은 컴포넌트·블록 install registry와 별도 집계합니다. 현재 884개 패턴은 원본 ID·pattern 출처, 한국어·영어 안내, 프리뷰, reduced-motion 지침과 보존된 소스 고지를 제공합니다. 미리보기와 JavaScript/React 구현은 같은 런타임을 사용하며 Canvas 재생은 CSS만으로 재현하지 않습니다.

응답과 호환성

검색 필터는 CLI와 동일한 query, kind, status, token, group, limit, cursor입니다. 중복 또는 알 수 없는 쿼리는 400입니다. v1의 추가 응답 필드는 허용하고, 호환되지 않는 구조 변경은 v2로 구분합니다.

Browser
const response = await fetch('https://design.klic.co.kr/api/v1/search?query=button&kind=component&limit=5');
if (!response.ok) throw new Error('HTTP ' + response.status);
const result = await response.json();
console.log(result.release, result.items, result.nextCursor);

인증 없는 공개 GET과 교차 출처 읽기를 제공합니다. 관리 API와 MCP 접근 인증은 별도입니다. 없는 ID는 404, 잘못된 입력은 400, 허용되지 않은 메서드는 405입니다.

테마 컨텍스트와 범위

축허용 값
idklic | paper | ink | analysis | electronics | compute | integrations | console | workspace | spatial
profilecore | studio | data
materialflat | glass | solid-glass | liquid-glass
modesystem | light | dark

전체 정의 인벤토리는 호환성을 위해 3,751개 토큰을 유지합니다. 외부 전달은 선택한 컨텍스트의 활성 참조를 따라 사용하지 않는 Primitive를 제외하며, 토큰 탐색기는 현재 컨텍스트와 전체 정의 범위를 구분합니다. Primitive 3,143개 중 2,496개(79.41%)는 재질 정의입니다.

형식은 프로젝트가 지원하는 타입과 4계층 참조 규칙을 검증합니다. 모든 DTCG 기능 지원이나 모든 화면의 WCAG 인증을 의미하지 않습니다.

요청 한도와 권한 키

채널60s / IP허용 키
API120무제한
Remote MCP60무제한
Source downloads2000무제한

초과 요청은 HTTP 429와 Retry-After를 반환합니다. API·MCP는 X-KLIC-API-Key 헤더, CLI는 KLIC_API_KEY 환경 변수를 지원합니다. 서버에 등록된 키만 한도에서 제외되며 관리 권한이나 MCP 인증을 부여하지 않습니다. 키를 URL·문서·브라우저 코드에 넣지 마세요.

이미 읽은 스냅샷의 stdio·WebMCP 호출과 --local 실행은 서버 요청을 만들지 않습니다. 초기 HTTP 레지스트리 조회와 소스 다운로드는 각각 서버 한도를 사용합니다.

수치의 집계 범위

범위계산
블록 전체247 + 80 = 327
실행 기본 검색109 + 247 = 356
준비 포함 레지스트리109 + 327 = 436
모션 카탈로그 (별도 집계)884

제공 형태와 버전 읽기

KLIC은 7개 디자인 디멘션과 4계층 토큰을 공통 기반으로 씁니다. 적용 기준은 다릅니다. 컴포넌트는 개별 조작 요소, 블록은 업무 흐름, 모션은 시간에 따른 전환을 다룹니다. 공개 npm: [email protected]. 소스 후보 [email protected]는 미발행이며 [email protected]가 현재 발행본입니다.

컴포넌트 109개와 실행 블록 247개는 CLI plan/add로 독립 참고 작업 폴더 356개를 제공합니다. 모션 884개는 source id + pattern 출처와 보존된 고지를 포함한 KLIC 각색 패턴이며 상세 화면·API·CLI motion get에서 HTML/CSS/JavaScript/React 소스를 제공합니다(CSS/React 예제 포함). 미리보기와 JavaScript/React 구현은 같은 런타임을 사용하며 Canvas 재생은 CSS만으로 재현되지 않습니다. 패키지는 components/*·blocks/*·motions/*를 제공하고, 모션 수는 작업 폴더 수와 별도로 집계합니다. 소스 후보 [email protected]는 미발행이며 [email protected]가 현재 발행본입니다.

표기의미
Toolkit 0.0.1CLI와 공유 연동 런타임 버전. npm 패키지 버전 0.0.4과 별도로 관리합니다.
Schema 1.0응답 데이터 형식
release 444ee642b9edec32레지스트리 배포 해시
revision 6f9c8f5e4d7c767f79a7db999670fb4d0936e07acb1b472fe162a7a9ade60c97디자인 기준 해시

라이선스 안내는 파일별 출처와 보존 고지의 색인입니다. 사이트 전체에 새 단일 라이선스를 부여하지 않습니다. Figma는 manifest와 이관 가이드를 제공하며 자동 동기화 기능과 구분합니다. 공개 KLIC 소스 저장소 주소는 현재 제공 계약에 등록되어 있지 않습니다.

References
https://design.klic.co.kr/licenses/README.md
https://design.klic.co.kr/design-contract/materials/figma-manifest.json
https://design.klic.co.kr/design-contract/materials/figma-migration.md
공통 디자인 기준 보기
공통 디자인 기준

기준 리비전: 6f9c8f5e4d7c767f79a7db999670fb4d0936e07acb1b472fe162a7a9ade60c97

기준 원문: https://design.klic.co.kr/api/v1/design-system.json

API·CLI·MCP·WebMCP의 designSystem과 동봉된 KLIC-DESIGN-SYSTEM.json에서 이 기준과 리비전을 확인합니다. 항목별 계약은 item.design.system으로 연결합니다.

디멘션토큰의 책임구조·행동의 책임
크기와 비율컨트롤 크기·아이콘·콘텐츠 폭min-height·패딩·줄바꿈·실제 hit area는 컴포넌트 recipe와 DOM에서 보장
타이포그래피등록 family·역할별 크기·굵기행간·자간·줄바꿈·반응형 조건은 지원 recipe에서 정의; 등록되지 않은 타입을 가정하지 않음
색과 대비행동·선택·텍스트·경계·상태의 역할 색레이블·아이콘·상태 속성으로 의미 전달; 합성 표면의 실제 대비는 토큰 밖에서 측정
배치와 정렬콘텐츠 최대 폭·패널 폭 등 등록된 공간 역할DOM 읽기 순서·배치 전환·스크롤 소유권·Portal 구조
간격과 그룹화내부 gap·padding·그룹 사이 간격과 승인 밀도 매핑label·fieldset·legend·describedby 등의 관계; 창 폭만으로 밀도를 변경하지 않음
표면과 깊이표면색·반경·경계 및 지원 color/dimension 소재 leafblur·shadow 합성 recipe·stacking·보조 패널과 모달 구분·불투명 fallback
상호작용과 피드백focus·선택·진행·성공·경고·오류의 시각 역할키보드·focus 이동·비동기 전이·실행 차단·입력 보존·복구 경로

Primitive만 literal 소유. Brand→Primitive, Semantic→Brand, Component→Semantic 인접 참조 유지.

토큰 정의, DOM/CSS recipe의 구조 조건, 컴파일된 최종 literal 출력을 구분한다.

모션 레시피는 컴포넌트·블록 설치 항목과 별도 읽기 카탈로그로 유지하되, 브라우저 검색·미리보기·상세 UI는 KLIC Interface Library 홈페이지의 기존 #motion 메뉴에서 제공한다. 읽기 API·CLI·MCP·WebMCP도 같은 정본 카탈로그를 사용한다. 적용 범위는 사용자 제공 참조 소스의 884개 패턴·67개 분류이며, 기존 KLIC 카테고리/항목 탐색 동작에 그룹으로 싣는다. 기존 단순화 280개 카탈로그, 그 전용 경로와 별칭은 현 카탈로그에서 제외하고 호환 항목으로 유지하지 않는다. 각 채택 항목에는 원본 source id·pattern·engine을 연결하고, Copyright © 2026 acc0mplish. All rights reserved. 및 원본 라이선스 고지를 보존하며 KLIC 자체 제작으로 표시하지 않는다. 원본 안무·시간·경로·레이어·SVG/inline/WAAPI alpha는 보존한다. 외관은 KLIC 4계층 토큰 경로의 색·폰트·표면·테두리·radius·spacing으로 각색하고 Canvas도 같은 팔레트·폰트 토큰을 사용한다. 데모 CSS는 항목 범위로 격리한다. 같은 source runtime이 미리보기와 JavaScript/React 전달을 구동하며 Canvas 재생을 CSS만으로 제공한다고 주장하지 않는다. KLIC 각색본은 블루·네이비·중립 팔레트와 reduced-motion·replay·cleanup 계약을 따르고 출시 전 light/dark/mobile 및 실제 재생을 검증한다. NPM 패키지는 홈페이지와 별도 산출물이며, 현재 소스 후보의 export를 발행된 버전의 기능으로 소개하지 않는다. NPM export 안내는 확인된 발행 manifest에 근거한다.

프리셋의 허용 범위

Preset은 기존 API의 승인된 설정 조합이며 토큰의 다섯 번째 계층이 아니다.

해당 컴포넌트 API가 실제 지원하는 size·variant·density·layout 등 명시적 allowlist

  • label·설명·업무 데이터
  • value·selection·validation·request 상태
  • 이벤트 핸들러·복구 액션·권한
  • 원시 스타일 값·미등록 CSS 변수·임의 토큰 override

컴포넌트 기본값 → 선택한 preset → 허용된 명시적 설정. 업무 데이터·상태·권한은 별도 입력으로 처리한다.

허용 키·enum·조합을 검사하고 모르는 값은 진단한다. 타입 선언과 실제 DOM·동작 검증을 구분한다.

충돌 해결 순서
  • 정보·조작·접근성을 먼저 보존: 핵심 정보·상태 의미·입력·focus와 조작 경로를 보존한다. 디멘션 번호로 다른 필수 계약을 무효화하지 않는다.
  • 구조와 읽기 순서를 재배치: 줄바꿈·열 전환·행동 묶음·패널 배치를 먼저 조정한다. 의미상 필요한 2차원 영역만 국소 스크롤을 사용한다.
  • 승인 범위에서 간격·표면 조정: 사용자가 선택한 밀도와 글자 배율을 존중하며 승인된 recipe 안에서 여백·장식을 조정한다. 공간 부족만으로 자동 compact나 글자 축소를 적용하지 않는다.
  • 남는 제약과 검증을 기록: 기본값으로 해결되지 않으면 적용 범위·대안·영향·FR/AT·실제 검증을 기록한다. 토큰 계층을 건너뛰거나 검증 실패를 예외 승인으로 덮지 않는다.

sources/checks는 연결 근거이며 통과 인증이 아니다. 제품별 실제 환경 검증 결과는 기존 FR/AT 기록에서 관리한다.

적용과 검증

공통 기준과 항목별 DESIGN.md·실제 소스를 먼저 읽습니다. 규칙마다 토큰·DOM·CSS recipe·상태 처리의 책임을 나누고 제품에 필요한 조건을 적용합니다.

기준 본문과 항목 계약의 revision을 비교합니다. release는 레지스트리 배포를 식별하므로 서로 다른 배포의 페이지 결과를 섞지 않습니다.

최신 CLI와 로컬 레지스트리를 사용하고 stdio 세션을 재시작합니다. WebMCP는 페이지를 새로 읽어 등록합니다. source는 원시 코드만 출력합니다. 소스 묶음은 DESIGN.md, 테마 키트는 README.md를 KLIC-DESIGN-SYSTEM.json과 함께 읽습니다.

참고 문서의 선택적 채택

외부 문서와 초안은 검토 후보로 취급한다. KLIC의 현재 문제·구현·계약을 확인하고 필요한 규칙만 채택하며, 보류·기각의 이유와 적용 범위를 남긴다.

참고 문서의 제품명·예제 API·출처를 KLIC의 구현 사실로 옮기지 않는다. 채택한 규칙은 실제 토큰·DOM·CSS recipe·상태 처리와 검증 근거에 연결한다.

변경 시 함께 확인할 범위

문제 제기는 관련 사용 경로 전체의 변경 영향을 검토하는 출발점이다. 사용자가 언급한 화면이나 도구만 수정하고 완료로 처리하지 않는다.

  • 구현 원본·토큰·컴포넌트·타입·스키마
  • DOCS·웹 가이드·개발자 문서·예제
  • MCP·CLI·WebMCP·API의 설명·입력·응답
  • AI 프롬프트·llms.txt·소스와 테마 내보내기
  • 회귀 검사·빌드·운영 배포와 실제 응답

정본을 수정한 뒤 관련 가이드·예제·도구·프롬프트·내보내기를 함께 재생성하고 같은 리비전을 검사한다. 영향을 받지 않는 경로는 이유를 기록하며, 실제 확인한 결과와 남은 미검증 조건을 구분해 보고한다.