사용자가 실시간으로 열람하고 있는 문서 목록을 반환하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다. 대상으로 "공개한 문서"를 선택하면 호출 시점에 공개되어 있는 문서만 대상으로 하고, 공개하지 않은 문서에는 API_HAS_NOT_DOC 예외를 반환합니다.
MONITOR_DOC_ACCESS 옵션 설정
이 API를 사용하려면 콘솔에서 다음 명령어를 실행합니다.
set-preference -name MONITOR_DOC_ACCESS -value true
다음 옵션으로 설정한 시간 안에 접근한 문서 정보만을 반환합니다. 단위는 분이고 기본 값은 5분입니다.
set-preference -name DOC_ACCESS_MONITOR_DURATION -value 10
API 요청
GET 형식으로 요청해야 합니다.
요청 URL 형식입니다.
/r/api/${uuid}?action=REALTIME_DOC_LIST_BY_USER&userId=${userId}URL 파라미터 항목입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
uuid | UUID | API UUID | 예 | 5b969d63e97cfec7 |
action | 문자열 | 작업 유형 | 예 | REALTIME_DOC_LIST_BY_USER |
userId | 문자열 | 사용자 아이디 | 예 | user01 |
요청 URL 예제입니다.
/r/api/5b969d63e97cfec7?action=REALTIME_DOC_LIST_BY_USER&userId=user01
API 응답
REALTIME_DOC_LIST_BY_USER 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 | |
documents | Document 객체 배열 | 문서 데이터 목록. 최근에 접근한 문서부터 정렬합니다. API 상세 화면에서 설정한 문서만 포함합니다. | 예 |
열람하고 있는 문서가 없을 때는 documents로 빈 배열을 반환합니다.
Document 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | UUID | 예 | 5b969d63e97cfec7 |
type | 문자열 | 문서 유형 | 예 | BOOK |
title | 문자열 | 문서 제목 | 예 | 매뉴얼웍스 사용자 가이드 |
chapters | Chapter 객체 배열 | 장 데이터 목록 | 예 | |
project | 문서가 속한 프로젝트 데이터 | 아니오 |
Chapter 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | UUID | 예 | fe3294d60c1b7cd3 |
type | 문자열 | 장 유형 | 예 | CHAPTER |
title | 문자열 | 장 제목 | 예 | 에디터 시작하기 |
Project 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | UUID | 예 | 2b560cf2c5262597 |
name | 문자열 | 프로젝트 이름 | 예 | 매뉴얼웍스 5.0 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
USER_NOT_EXIST | 사용자가 존재하지 않을 때 |
MONITOR_DOC_ACCESS_NOT_CONFIGURED | MONITOR_DOC_ACCESS 옵션을 설정하지 않았을 때 |
예제
예제입니다.
{
"status": "success",
"documents": [
{
"id": "b9c0451a065c571a",
"type": "BOOK",
"title": "매뉴얼웍스 사용자 가이드",
"chapters" : [
{
"id": "fe3294d60c1b7cd3",
"type": "CHAPTER",
"title": "에디터 시작하기"
},
{
"id": "2c655965f8d66b81",
"type": "APPENDIX",
"title": "책의 구조"
}
],
"project": {
"id": "2b560cf2c5262597",
"name": "매뉴얼웍스 5.0"
}
},
{
"id": "6ce0f679211fb475",
"type": "BOOK",
"title": "매뉴얼웍스 관리자 가이드",
"chapters" : [
{
"id": "4bf222fbca45e6c1",
"type": "CHAPTER",
"title": "UI 색상 바꾸기"
},
{
"id": "f1dc193a03b321c8",
"type": "APPENDIX",
"title": "라이선스 키 바꾸기"
}
]
}
]
}