가이드
API 범위
앱 연결로 받은 토큰으로 API를 호출합니다. 전체 목록은 API 레퍼런스에 있습니다.
영역
| 영역 | 할 수 있는 것 |
|---|---|
| 매장 | 매장 정보와 영업시간 |
| 예약 | 예약 조회와 생성, 시간 변경, 입실·퇴실, 노쇼 처리, 빈 시간 조회 |
| 손님 | 손님 검색과 등록, 회원권 조회·발급·수정·해지·일시정지·재개, 출입 허가, 명부 반입 |
| 문의 | 모든 채널의 대화 읽기, 답장, 내부 메모, 대화 종료와 담당 변경 |
| 메시지 | 발송된 메시지 |
| 매출 | 매출 요약과 추이, 결제 내역(조회만) |
| 상품 | 상품 판매와 재고(조회만) |
| 프로모션 | 쿠폰, 캠페인과 성과 |
| 직원 | 직원, 근무 기록, 출근 요약 |
| 기기 | 기기와 상태, 문 출입 기록, 루틴 조회, 기기 제어, 루틴 실행 |
MCP 도구와 같은 이름
API의 각 작업은 Claude와 ChatGPT 커넥터가 쓰는 MCP 도구와 같은 이름을 가집니다. 레퍼런스의 x-mcp-tool 값이 도구 이름입니다.
읽기와 쓰기
- 읽기는 바로 호출해도 됩니다.
- 쓰기는 매장 데이터를 바꿉니다. 호출하기 전에 사용자에게 확인하세요.
범위
- 연결할 때 고른 매장이나 조직이 대상입니다. 조직 연결은 닿는 매장 전체를 다루고, 응답 행에
placeId가 들어갑니다. - 조직 연결로 예약을 만들 때는 요청에
placeId를 넣습니다. - 토큰의 권한이 곧 앱의 권한입니다. 권한이 없는 작업은 403입니다.
제공하지 않는 것
환불, 결제, 권한 부여는 API로 제공하지 않습니다. 콘솔에서 처리합니다.
다음
Last modified on