Skip to content
BranchesTags

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
llms
llms
 
 
README.md
README.md
 
 
admin-llms.txt
admin-llms.txt
 
 
front-llms.txt
front-llms.txt
 
 
llms.txt
llms.txt
 
 

Repository files navigation

카페24 쇼핑몰 API LLMs

AI 도구를 위한 카페24 쇼핑몰 API llms.txt 문서
Admin API · Front API · OAuth 2.0 · Front SDK · Webhook

AI 활용 가이드 · llms.txt · 포함 범위 · 프롬프트 예시 · 도구별 가이드

소개

카페24 쇼핑몰 API를 AI 도구가 읽기 쉬운 llms.txt 형식으로 정리한 문서 저장소입니다.

AI 활용 가이드

카페24 API 문서는 사람뿐 아니라 AI 도구도 활용할 수 있는 개발자 문서입니다. 이 저장소는 카페24 API의 llms.txt 파일을 활용해 LLM(대규모 언어 모델) 도구에서 문서를 더 효율적으로 탐색하고, 연동에 필요한 정보를 빠르게 찾을 수 있도록 구성되어 있습니다.

llms.txt란

llms.txt는 AI 도구와 에이전트가 웹사이트나 문서의 핵심 정보를 효율적으로 이해하고 탐색할 수 있도록 구조화한 마크다운 기반의 안내 파일입니다. robots.txt가 검색 엔진 크롤러를 위한 표준이라면, llms.txt는 LLM을 위한 문서 접근 표준입니다.

AI 도구가 일반 HTML 페이지를 처리할 때는 내비게이션, 스크립트, 스타일시트 등의 요소를 함께 읽어 컨텍스트 윈도우를 비효율적으로 소모합니다. llms.txt 파일은 이러한 노이즈를 줄이고, API 문서의 구조와 핵심 정보만을 LLM이 바로 처리할 수 있는 형태로 제공합니다.

llms.txt 표준의 자세한 내용은 llms-txt를 참고하세요.

카페24 API llms.txt

제공 파일

파일 URL 설명
llms.txt GitHub 링크 카페24 API 문서 구조와 Admin/Front API 인덱스 링크를 제공하는 시작 파일
admin-llms.txt GitHub 링크 OAuth 2.0 기반 Admin API 문서 인덱스
front-llms.txt GitHub 링크 HTTP Basic 인증 기반 Front API 문서 인덱스

llms.txt 파일은 카페24 API의 전체 구조를 마크다운 형식으로 요약하며, 각 API 그룹별 상세 문서 파일(.md) 링크를 포함합니다. AI 도구는 이 파일을 시작점으로 삼아 필요한 API 영역의 상세 스펙을 탐색할 수 있습니다.

포함 범위

현재 llms.txt에서 접근할 수 있는 API 문서는 다음과 같습니다.

API 그룹 포함 내용
공통 소개 인증, 요청/응답, 쿼리 패턴, 호출 제한, 버전 관리
Admin API OAuth 2.0 기반 상점 운영자 권한 API
Front API HTTP Basic 인증 기반 쇼핑몰 방문 고객 권한 API
상품 상품 조회, 등록, 수정, 삭제, 옵션, 품목, 재고, 아이콘, 꾸미기 이미지
상품분류 카테고리, 메인분류, 분류 SEO, 진열 정보
주문 주문 조회, 결제, 배송, 취소, 교환, 반품, 환불, 수령자, 메모, 혜택
회원 고객, 회원등급, 적립금, 예치금, 개인정보, 소셜 정보
게시판 게시글, 댓글, 긴급문의, 댓글 템플릿, 게시판 SEO
프로모션 쿠폰, 혜택, 고객 이벤트, 장바구니 혜택
배송 배송업체, 배송비, 공급사 배송, 지역별 배송 설정
상점 쇼핑몰 설정, 결제수단, PG, 운영자, SMS, 리다이렉트
앱 일반앱 개발, Webhook, ScriptTag, App Store 주문/결제
Front SDK JavaScript SDK, 고객 세션, 장바구니·혜택, SDK 오류

활용 상황

외부 개발사

  • 카페24 연동에 필요한 인증, 상품, 주문 문서를 빠르게 찾고 싶은 경우
  • 특정 기능 구현을 위해 어떤 API를 먼저 검토해야 하는지 파악하고 싶은 경우
  • 연동 중 발생한 오류 원인이나 관련 문서를 빠르게 확인하고 싶은 경우
  • Admin API와 Front API 중 어떤 API를 사용해야 하는지 구분하고 싶은 경우

쇼핑몰 운영자 또는 운영 담당자

  • 주문 처리 자동화, 상품 관리 자동화, 회원 관리 자동화에 필요한 API 범위를 파악하고 싶은 경우
  • 장바구니, 적립금, 쿠폰, 관심상품 등 고객 경험 관련 기능을 API로 연결할 수 있는지 검토하고 싶은 경우
  • Webhook, ScriptTag, Front SDK를 조합해 쇼핑몰 기능을 확장하려는 경우

권장 활용 방법

카페24 API의 llms.txt 파일은 AI 도구에 문서 탐색의 시작점을 제공하는 용도로 사용하는 것을 권장합니다.

  1. 사용하는 AI 도구에 llms.txt 파일 주소를 전달합니다.
  2. 구현하려는 업무 목적과 조건을 함께 설명합니다.
  3. 관련 문서, 필요한 API, 인증 방식, 주의사항을 정리해 달라고 요청합니다.
  4. 상세 스펙이 필요한 경우, llms.txt 파일에 링크된 개별 .md 문서를 추가로 전달합니다.
  5. 실제 개발 또는 운영 반영 전에는 반드시 원문 카페24 API 문서를 다시 확인합니다.

프롬프트 예시

예시 1. Admin API 인증 구조 만들기

다음 카페24 API llms.txt를 기준으로 Admin API 인증 구조를 만들려고 합니다.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

목표:
- OAuth 2.0 인증 흐름 이해
- Access Token과 Refresh Token 발급/갱신 구조 설계
- 토큰 저장, 만료 처리, 재인증 처리 기준 정리
- API 호출 공통 클라이언트 구조 제안

출력 형식:
1. 먼저 읽어야 할 문서
2. 인증 흐름 단계별 설명
3. 서버에서 구현할 구성 요소
4. 주의해야 할 보안 사항
5. 예시 코드 작성 전에 확인할 질문

예시 2. Admin API와 Front API 선택하기

다음 카페24 API llms.txt를 기준으로 기능별로 Admin API와 Front API 중 어떤 것을 써야 하는지 판단하고 싶습니다.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

구현하려는 기능:
- 상품 목록 보여주기
- 상품 상세 조회
- 장바구니 담기
- 주문 목록 관리
- 회원 등급 조회
- 쇼핑몰 운영자용 주문 처리

출력 형식:
1. 기능별 권장 API 구분
2. 필요한 인증 방식
3. 서버에서 호출해야 하는 API와 브라우저에서 호출 가능한 API 구분
4. 잘못 선택하기 쉬운 지점

예시 3. 주문 변경분 수집 API 찾기

다음 카페24 API llms.txt를 기준으로 주문 변경분을 주기적으로 수집하려고 합니다.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

목표:
- 주문 상태 변경분을 주기적으로 조회
- 필요한 인증 방식과 호출 제한도 함께 확인
- 어떤 API를 어떤 순서로 검토하면 좋은지 정리

출력 형식:
1. 관련 문서
2. 우선 검토할 API
3. 구현 시 주의사항
4. 추가로 읽어야 할 상세 문서

예시 4. 상품 등록 자동화 범위 파악

다음 카페24 API llms.txt를 기준으로 상품 등록 자동화를 검토하고 있습니다.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

원하는 결과:
- 상품 등록/수정과 관련된 문서 정리
- 인증과 사전 준비사항 정리
- 자주 발생할 수 있는 오류나 주의사항 정리
- 구현 순서를 단계별로 제안

예시 5. Front API로 상품 진열 화면 만들기

다음 카페24 API llms.txt를 기준으로 쇼핑몰 프론트 상품 진열 화면을 만들려고 합니다.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

목표:
- 상품 목록, 상품 상세, 상품분류 정보를 조회
- Front API 인증 방식 확인
- 브라우저에서 호출할 때 주의할 점 정리
- 필요한 경우 Front SDK 사용 여부 판단

출력 형식:
1. 관련 Front API 문서
2. 필요한 API 호출 순서
3. 화면 구성에 필요한 주요 응답 필드
4. 캐싱, 호출 제한, 오류 처리 주의사항

예시 6. Webhook 수신 서버 설계하기

다음 카페24 API llms.txt를 기준으로 Webhook 수신 서버를 만들려고 합니다.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

목표:
- Webhook 설정과 수신 형식 파악
- X-API-Key 검증 방식 정리
- 이벤트 누락 보정과 재처리 전략 설계
- 주문/상품/회원 이벤트 처리 구조 제안

출력 형식:
1. 관련 문서
2. Webhook 수신 흐름
3. 보안 검증 항목
4. 저장해야 할 이벤트 데이터
5. 장애 대응 및 재처리 전략

예시 7. API 오류와 호출 제한 대응 정리

다음 카페24 API llms.txt를 기준으로 API 오류 처리와 호출 제한 대응 방식을 정리해 주세요.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

확인하고 싶은 내용:
- 공통 오류 응답 형식
- HTTP status code별 처리 기준
- 호출 제한과 429 응답 대응
- 재시도 가능한 오류와 재시도하면 안 되는 오류 구분

출력 형식:
1. 먼저 읽을 문서
2. 오류 처리 공통 정책
3. 재시도 정책 예시
4. 운영 로그에 남겨야 할 항목

예시 8. 상세 API 스펙 기반 코드 생성

llms.txt 파일은 문서 탐색의 시작점입니다. 특정 API의 파라미터, 응답 스키마, 오류 코드까지 정확하게 참조하려면 llms.txt 파일에 링크된 개별 상세 문서(.md)를 함께 전달하는 것이 효과적입니다.

다음 문서들을 참고해 주세요.

1. 카페24 API 전체 구조: https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt
2. Admin API 인덱스: https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/admin-llms.txt
3. Front API 인덱스: https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/front-llms.txt

위 문서를 기반으로 주문 조회부터 배송 처리까지의 API 호출 순서와
각 단계별 인증 방식, 요청/응답 확인 포인트를 정리해 주세요.

LLM 도구별 적용 가이드

모든 LLM 도구의 기본 패턴은 동일합니다. llms.txt 파일의 URL을 전달하거나, 파일을 다운로드해 첨부한 뒤 업무 목적을 함께 설명합니다.

웹 기반 LLM

도구 URL 직접 전달 파일 업로드 비고
ChatGPT 가능 가능 URL을 프롬프트에 포함하거나 파일을 첨부해 문서를 참조할 수 있습니다.
Claude 가능 가능 URL 전달 또는 파일 첨부가 가능합니다. 더 확실한 컨텍스트를 제공하려면 파일 첨부를 권장합니다.
Gemini 가능 가능 URL 또는 파일 첨부 방식으로 활용할 수 있습니다.
Gemini in Chrome 브라우저 탭 기반 해당 없음 브라우저에서 llms.txt 파일을 열어둔 상태에서 현재 탭 기반으로 질문할 수 있습니다.

공통 사용 예시:

다음 카페24 API llms.txt를 기준으로 관련 문서를 찾아 주세요.
https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

목표는 주문 조회와 배송 처리 자동화입니다.
관련 문서, 인증 방식, 호출 제한, 구현 시 주의사항을 함께 정리해 주세요.

데스크톱 앱

도구 URL 직접 전달 파일 업로드 비고
ChatGPT Desktop 가능 가능 웹 버전과 동일하게 URL 전달 또는 파일 첨부가 가능합니다.
Claude Desktop 가능 가능 파일 드래그 앤 드롭으로 명시적인 컨텍스트를 제공할 수 있습니다.

파일 업로드 방식은 문서를 명시적으로 컨텍스트에 포함하고 싶을 때 유용합니다. llms.txt 파일과 함께 필요한 상세 문서(.md)를 추가로 첨부하면 더 정확한 답변을 받을 수 있습니다.

AI 기반 코딩 에디터

AI 기반 코딩 에디터를 사용하는 경우, 카페24 API llms.txt 파일을 외부 문서나 프로젝트 지침으로 등록해 코드 작성 시 참조 컨텍스트로 활용할 수 있습니다.

Cursor

  1. Settings > Indexing & Docs에서 Add Doc을 클릭합니다.
  2. URL에 https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt를 입력해 등록합니다.
  3. 채팅에서 @Docs로 등록된 카페24 API 문서를 컨텍스트로 지정합니다.

VS Code (GitHub Copilot)

프로젝트 루트에 .github/copilot-instructions.md 파일을 생성해 참조 정보를 작성합니다.

## 카페24 API 연동 참조

- API 문서 (LLM용): https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt
- Admin API 인덱스: https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/admin-llms.txt
- Front API 인덱스: https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/front-llms.txt
- Admin API Base URL: https://{mallid}.cafe24api.com/api/v2/admin/
- Front API Base URL: https://{mallid}.cafe24api.com/api/v2/
- Admin 인증: OAuth 2.0 Bearer Token
- Front 인증: HTTP Basic 인증(client_id + front_api_key)

Windsurf

Cascade 패널에서 @ 멘션을 사용해 다음과 같이 문서를 직접 참조할 수 있습니다.

@https://github.com/KnifeLemon/Cafe24-API-LLMs/blob/main/llms.txt

유의 사항

  • AI 도구의 응답은 항상 검증이 필요합니다. LLM이 생성한 코드나 설명은 API 문서의 실제 스펙과 다를 수 있습니다.
  • 프로덕션 적용 전 반드시 공식 카페24 API 문서를 확인하고 실제 API 호출로 검증하세요.
  • AI가 문서에 없는 내용을 추측할 수 있습니다. 불확실한 내용은 원문 문서에서 다시 확인해야 합니다.
  • 인증 정보를 AI 도구에 입력하지 마세요. Client Secret, Access Token, Refresh Token, front_api_key 등 민감 정보는 AI 대화에 포함하지 않아야 합니다.
  • 이 저장소의 llms.txt 파일은 API 문서 탐색을 돕기 위한 인덱스입니다. API 변경 시 문서 반영 시점에 차이가 있을 수 있습니다.
  • 카페24 개발자센터 가입, 앱 등록, 쇼핑몰 권한 승인 등 서비스 이용 절차는 공식 문서를 함께 확인하세요.

About

카페24 쇼핑몰 API LLMs

knifelemon.github.io/Cafe24-API-LLMs/

Topics

cafe24cafe24apiecommercellms

Resources

Readme
Activity

Stars

4 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors