API 레퍼런스

사업자와 사용자

bookmi 사업자를 조회·등록하고, 해당 사업자의 사용자를 조회·등록·정지합니다. 비밀번호는 보관하지 않으며, 설정 메일은 bookmi 가 보냅니다.

• 사업자 조회·등록
• 사용자 조회·등록·정지
• 설정 메일 재발송

로그인(SSO)

고객이 bookmi 계정 그대로 귀사 서비스에 로그인할 수 있습니다. 표준 인가 코드 플로로, 서명된 ID 토큰을 돌려드립니다.

• 인가 코드 플로
• ID 토큰(공개 키로 검증)
• 정지·잠금 시 세션 무효화

계약과 구매

사업자가 이용할 수 있는 요금제·옵션·제품을 가져오고, 요금제와 포인트 팩의 구매 링크를 발행합니다. 결제는 사업자 본인이 bookmi 확인 화면에서 합니다.

• 권익 조회
• 요금제·포인트 팩 목록
• 구매 링크 발행
• 주문 조회

포인트와 계량

귀사 서비스에서 사용한 만큼을 사업자의 bookmi 포인트로 정산합니다. 사용 전 가부 판정, 잔액, 이용 명세(대사용)도 제공합니다.

• 이용 가부 판정
• 잔액 조회
• 이용 계량
• 이용 명세

지식 검색

사업자의 지식 베이스를 질문 문장으로 검색합니다. 읽기 전용이며, 일괄 내보내기는 하지 않습니다.

• 질문으로 검색

Webhook

변화가 있을 때 지정한 https URL 로 서명을 붙여 알려 드립니다. 폴링이 필요 없습니다.

• 제품 개통·정지
• 계약 구매·만료
• 포인트 구매
• 사업자 정보 갱신
• 사용자 정지·잠금·복귀

예약이나 고객 데이터를 읽고 쓸 수 있나요?

현재는 제공하지 않습니다. 제공하는 것은 사업자와 사용자, 로그인(SSO), 계약과 구매, 포인트 계량, 지식 검색, 이벤트 알림입니다. 필요한 데이터가 있으면 상담해 주세요.

어떤 서비스가 연결되어 있나요?

그룹 내 AI 전화가 첫 연결 대상입니다. 외부 서비스와의 연결은 용도를 들은 뒤 상담해 드립니다.

호출 횟수에 제한이 있나요?

있습니다. 서비스 전체와 사업자별 2단계로 상한이 있습니다(수치는 사양서에 기재). 상한에 걸리면 응답의 Retry-After 에 따라 기다린 뒤 다시 시도해 주세요.

사양이 바뀌나요?

API 는 버전으로 관리합니다. 호환되지 않는 변경은 새 버전을 병행해 내고, 이전 버전은 최소 6개월 유지합니다. 항목 추가는 호환 변경이므로 모르는 항목은 무시해 주세요.

데이터 안전은 어떻게 보장되나요?

통신은 HTTPS(TLS)로 암호화하고, 키는 언제든 폐기·재발급할 수 있으며 Webhook 에는 서명을 붙입니다. 데이터는 도쿄의 데이터센터에 보관하며, bookmi 가 AI 모델 학습에 쓰는 일은 없습니다. 자세한 내용은 「보안」 페이지를 확인해 주세요.