home
쏠북 가이드
home
쏠북 이용 가이드
자주 묻는 질문
회사 소개
업데이트 소식
쏠북 매거진
브랜드 저자 모아보기
저자 지원하기
쏠북 저작권 보호센터
저작권 교육
R인증이란?
UCI코드란?
저작권 라이선스 구매
home

사용량 기반 API

Description

고객사의 라이선스 상품(교재, 참고서 등)의 사용량을 측정, 산출할 수 있는 데이터를 적재하는 API

Host

production: https://jmk9mhp7t8.execute-api.ap-northeast-2.amazonaws.com/prod
staging: https://jmk9mhp7t8.execute-api.ap-northeast-2.amazonaws.com/staging

Method & Path

POST /license/usage

Request

header parameter

•
Content-Type: application/json
•
Authorization : Bearer + API Key (API Key는 이메일로 전달 예정)
◦
ex) Bearer eyJpZCI6IkMxMDE3IiwibmFtZSI6I

path parameter

•
None

query string 파라미터

•
None

request body

request body
Name
type
required
Nullable
Description
data
Open
String
true
false
사용량을 측정할 수 있는 교재사용 해제와 관련된 데이터 Object을, base64 인코딩한 문자열 아래 Data 테이블에 교재사용 해제와 관련된 데이터 Object 구조를 확인할 수 있음
Data
Name
type
required
Nullable
Description
bookHash
Open
String
true
false
라이선스 해쉬값 또는 id
purchasedAt
Open
Timestamp
true
false
전자책 구매했을 경우 타임스탬프 일자
userHash
Open
String
true
true
유저 해쉬값 또는 id
tutorHash
Open
String
true
true
튜터 해쉬값 또는 id
matchHash
Open
String
true
true
매칭 해쉬값 또는 id
bookTitle
Open
String
true
false
라이선스명
isbn
Open
Number
true
false
isbn
eventType
Open
String
true
false
라이선스 사용 관련 이벤트 유형 ———————————————— BOOK_DELETED_BY_STAFF : 라이선스 사용 해제 (내부직원 삭제) BOOK_REGISTERED_BY_STAFF : 라이선스 등록 (내부직원) BOOK_REGISTRATION_APPROVED: 라이선스 등록 MATCH_DEACTIVATED : 라이선스 사용 해제
registeredAt
Open
Date
true
false
라이선스 사용일자
deletedAt
Open
Date
true
false
라이선스 사용 해제, 삭제 일자
details
Open
Object
false
true
상세 정보
registerdEventHash
Open
String
true
true
등록 이벤트 해쉬값
eventHash
Open
String
true
false
이벤트별 고유 해쉬값

Response

Returns a JSON object with the following properties:

response body

respone body
Name
type
Nullable
Description
id
Open
String
데이터 등록 id
message
Open
String
리스폰스 메시지

Error Handling (Optional)

Example

200 OK
400 Bad request (body data is omitted)
400 Bad request (body data is not properly encoded)
401 Unauthorized (API Key (token) is invalid)

Cange Log

@6/13/2024 200 성공 응답내 id, message 내용 변경
@2/6/2024 운영 API 업데이트 및 스테이징 API URL invalidate
@12/29/2023 생성됨