문서(장) 내용 가져오기

장의 내용을 반환하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.

API 만들기

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 요청

GET 형식으로 요청해야 합니다.

요청 URL 형식입니다.

/r/api/${uuid}?action=DOC_CHAPTER_CONTENT&chapterId=${chapterId}

URL 파라미터 항목입니다.

이름

유형

설명

필수 여부

uuid

UUID

API UUID

5b969d63e97cfec7

action

문자열

작업 유형

DOC_CHAPTER_CONTENT

chapterId

UUID

장 아이디

aa4efc2946b1c380

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=DOC_CHAPTER_CONTENT&chapterId=aa4efc2946b1c380

API 응답

DOC_CHAPTER_CONTENT 응답

JSON 형식의 응답은 다음과 같습니다.

DOC_CHAPTER_CONTENT 응답

이름

유형

설명

필수 여부

status

문자열

상태

success | fail

errors

Error 객체 배열

예외

아니오


elements

Element 객체

단락 목록


태그로 공개했다면 태그 한 이후에 만든 단락은 elements 배열에 포함되지 않습니다.

Element 객체

Element 객체는 다음과 같습니다.

Element 객체

이름

유형

설명

필수 여부

id

UUID

단락 아이디

802c487204a962f2

type

문자열

단락 유형

normal

url

문자열

웹 뷰어 URL


content

문자열

단락 내용


예외 항목

예외 항목은 다음과 같습니다.

예외

설명

CHAPTER_NOT_EXIST

문서가 존재하지 않을 때

REQUIRED_PARAMETER_MISSING

API 요청에 필수 항목(chaperId)이 없을 때

예제

예제입니다.

{
	"status": "success",
	"elements": [
		{
		    "id": "acd783b1c55fdec8",
		    "type": "HEADING1",
		    "url": 	"https://www.3rabbitz.com/book_user_guide_4_0_ko#acd783b1c55fdec8",
		    "content": "텍스트 단락 만들기"
		},
		{
			"id": "caa0a001e83042f5",
			"type": "NORMAL",
			"url": "https://www.3rabbitz.com/book_user_guide_4_0_ko#caa0a001e83042f5",
		"content": "<텍스트 단락> 아이콘으로 텍스트 단락을 만듭니다."
		}
	]
}