superplace API
superplace API
매장을 다루는 API 하나입니다. 앱 연결(OAuth 2.1)로 받은 토큰을 Authorization: Bearer <토큰> 으로 보내 호출합니다. 할 수 있는 일은 연결한 사람의 권한을 따르고, 같은 연산이 Claude·ChatGPT 연결의 MCP 도구입니다. 모든 응답은 {"success": true, "data": …} 형태이고, 오류는 {"error": "코드", "message": "설명", "statusCode": 숫자}입니다. 「파트너 키(레거시)」 태그는 기존 파트너 연동만 쓰는 옛 길입니다.
Tags
매장
내 계정, 매장 정보, 영업시간 조회·설정, 공개 일정, 직원, 활동 기록을 다룹니다.
예약
예약과 공간(방·좌석)을 조회하고, 예약을 등록·변경·취소하며 입장 처리를 합니다.
손님
손님 명단과 회원권을 조회·등록하고, 회원권을 발급·수정·해지·일시정지·재개합니다. 다른 시스템의 명부 반입도 여기 있습니다.
문의
손님 문의 대화를 조회하고 답장, 노트, 종료 처리를 합니다.
메시지
손님에게 발송한 문자·알림톡과 내게 온 알림을 조회합니다.
매출
결제 내역과 매출 요약, 기간별 매출 추이를 조회합니다.
상품
판매 상품, 상품별 판매 실적, 재고를 조회합니다.
프로모션
쿠폰과 캠페인, 캠페인 성과를 조회합니다.
직원
직원의 출퇴근 기록과 근무시간 요약을 조회합니다.
기기
기기 상태를 확인하고 명령을 보냅니다. 카메라 사진, 루틴 실행, 출입 기록도 여기에 있습니다.
파트너 키(레거시)
기존 연동만 쓰는 옛 길입니다. 파트너 키를 토큰으로 바꾸고 출입 허가·출입 기록·출입 설정·예약 등록을 다룹니다. 새 연동은 앱 연결 토큰으로 다른 연산을 씁니다.
Security Schemes
oauth2
앱 연결(OAuth 2.1 인가 코드 + PKCE)로 받는 사람 토큰. 범위(scope)는 없고, 할 수 있는 일은 연결한 사람이 매장에서 가진 권한을 따릅니다. 발급 방법은 가이드 /docs/auth-oauth.
oauth2
partnerKey
레거시 — 파트너 키(spk_)를 POST /core/v1/auth/apikey/token 으로 교환한 15분 토큰. 기존 파트너 연동 전용이며 새 연동에는 쓰지 않습니다.
http