‹ 참고48 / 48‹ 이전

Bootpay Commerce API v1

부트페이 쇼핑몰(커머스)의 상품·장바구니·주문·회원·고객 소통·정기구독을 다루는 서버 API 입니다.

  • 기본 주소: https://api.bootapi.com/v1 (개발 https://dev-api.bootapi.com/v1)
  • 요청·응답 본문: JSON (Content-Type: application/json)
  • 시간대: 한국 표준시(Asia/Seoul)

이 문서를 받는 방법

어느 v1 주소든 Content-Type: text/markdown 또는 Accept: text/markdown 을 붙여 호출하면, 실제 API 를 실행하지 않고 그 API 의 개발 문서​​를 markdown 으로 돌려줍니다. 인증이 필요 없습니다.

# 상품 상세 API 의 문서
curl -H 'Accept: text/markdown' https://api.bootapi.com/v1/products/{id}

# 주문서 생성(POST) API 의 문서 — 주문은 만들어지지 않습니다
curl -X POST -H 'Content-Type: text/markdown' https://api.bootapi.com/v1/orders/preparebash

헤더 없이 여는 문서 주소도 있습니다.

  • GET /v1/docs — 이 색인
  • GET /v1/docs/<리소스> — 리소스 문서 전체 (예: /v1/docs/products)
  • GET /v1/docs/common/<이름> — 공통 문서

공통

문서 내용
인증 Basic 인증, scope, IP 보안, 인증 오류
회원 JWT 구매자 본인 API 의 Bootpay-User-JWT
오류 응답 오류 형식, HTTP 상태
페이지네이션 page / limit 규칙
멱등 키 Idempotency-Key 재시도

리소스

상점·상품

문서 내용
상점 상점 기본 정보
쇼핑몰 설정 쇼핑몰 설정 조회·수정
프로젝트 인증된 프로젝트 정보
상품 상품 목록·상세·등록·리뷰
카테고리 카테고리 트리
카탈로그 기획전·카탈로그

장바구니·혜택

문서 내용
장바구니 담기·수량 변경·삭제
찜 찜 목록
쿠폰 내 쿠폰·다운로드
포인트 내 포인트 잔액·내역
쿠폰 운영 발급 쿠폰 검색·회원별 사용 가능 쿠폰·적용 미리보기 (가맹점 서버)
쿠폰 템플릿 템플릿 관리·쿠폰존·수동 발급 (가맹점 서버)
쿠폰 정책 쇼핑몰 쿠폰 정책 조회·수정 (가맹점 서버)
적립금 운영 회원 적립금 지급·회수·만료 (가맹점 서버)

주문·배송

문서 내용
주문 주문서 생성·주문 조회
주문 처리 취소·구매확정·결과
청구서 청구서
배송 정책 배송비 정책
웹훅 웹훅 테스트

회원

문서 내용
회원 가입·로그인·세션·내 정보·탈퇴·주소록
회원 그룹 그룹·부서·초대
마이페이지 회원 본인 주문·구독 (회원 JWT)

고객 소통·상품평

문서 내용
공지사항 공지 조회 (고객) · 등록·수정·삭제 (가맹점 서버)
자주 묻는 질문 FAQ 조회 (고객) · 등록·수정·삭제 (가맹점 서버)
1:1 문의 회원 본인 문의 작성·조회·수정·삭제 · 답변 (가맹점 서버)
상품문의 상품별 문의·비밀글·비회원 문의 · 답변 (가맹점 서버)
상품평 내 상품평 작성·수정·삭제 · 판매자 답글 (가맹점 서버)

정기구독

문서 내용
정기구독 구독 조회·변경·해지·청구·수시결제
정기구독 청구 회차별 청구
정기구독 요청 구독 변경·해지 요청
구독 설정 구독 상품 설정

서버 연동·기타

문서 내용
SDK 서버 SDK 전용 쿠폰 API
입점사 지급 요청 가맹점 지정 금액 정산 방식의 지급 등록·조회
토큰 발급 (레거시) Bearer 토큰 — 신규 연동 금지
알림톡 (이전됨) message-api 로 옮겨진 옛 주소

함께 보기