시작하기
Quartz Vend의 스토어 데이터 조회, 주문 지급, 환불 업무를 외부 시스템과 연동하는 방법을 안내합니다.
연동 준비
Open API와 Webhook은 활성 Pro 이상 플랜에서 사용할 수 있습니다. 운영 API의 기본 주소는 다음과 같습니다.
Base URL
https://api.quartz-vend.com- 1.
API 키 만들기
스토어 대시보드의 연동·개발자 메뉴에서 API 키를 발급합니다.
- 2.
사용할 기능 선택
주문 조회, 상품 지급 등 연동할 기능의 권한을 선택합니다.
- 3.
첫 요청 보내기
Open API 가이드의 예제에 내 스토어 ID와 키를 넣어 호출합니다.
연동 가이드
Open API
API 키 발급과 기능별 호출 예제
Webhook
이벤트 수신, 서명 검증, 중복 처리와 재시도
상품 지급
수량별 지급·교환·환불, 외부 재고 서버 연동
자동충전 설정
Android 은행 알림과 iOS SMS 연결
은행 알림 수신과 기기 연결은 자동충전 전용 연동입니다. Open API 키로 호출하는 기능이 아닙니다.
API 제공 범위
대시보드의 모든 정보와 작업을 공개 API로 제공하지는 않습니다. 각 API 참조에 명시된 필드와 작업만 지원합니다.
| 리소스 | API 지원 | 대시보드 전용·미제공 |
|---|---|---|
| 사용자 | 프로필·구매 등급·기존 잔액·스토어 포인트 조회, 메모·이용 제한·등급·금액 조정 | 이메일·본인확인 원문, Quartz EXP, 관리자 권한 변경 |
| 주문·지급 | 주문·선택 옵션·수량별 지급 상태 조회, 지급·교환 | 구매자 자유 입력 원문, 지급된 재고 원문, 판매자 메모·전체 교환 이력 |
| 환불 | 수량별 환불 접수·조회, 판매자의 송금 완료 기록 | 은행 자동 송금, 증빙 파일·구매확인증 조회 |
| 상품·재고 | 상품·옵션·재고 현황 조회, 재고 추가·제거, 외부 지급 실행 설정 | 상품 생성·수정·삭제, 원가, 재고 원문 조회, Provider 주소·자격 증명 변경 |
| 후기·쿠폰 | 후기·판매자 답글 조회, 쿠폰 조회·생성·수정·비활성화 | 후기 작성·수정·답글·삭제, API 참조에 없는 쿠폰 조건 |
| 일반·보안 설정 | 이름·소개·검색 노출·소셜 링크 등 일반 설정, 접속 제한·MFA 정책·신뢰 이메일 도메인 | 소유권·판매자·입금 계좌·파일 업로드·자격 증명 관리 |
| Webhook | 수신 주소·구독 이벤트 관리, 서명 키 교체·전송 테스트 | 전송 로그 전체 조회 |
일반·보안 설정 API도 허용된 필드만 변경합니다. 연동 기능이 추가되어도 기존 키의 Scope는 자동으로 확대되지 않습니다.
API 키 관리
- 키는 서버에 보관합니다. 웹 페이지나 모바일 앱에 넣으면 다른 사람이 가져갈 수 있습니다.
- 조회용 키와 지급·환불용 키를 분리해 사용할 수 있습니다.
- 키가 노출되면 대시보드에서 폐기하고 새로 발급합니다.