태그를 만드는 API입니다.

API 만들기

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

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

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.

API 요청 형식

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

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	TAG_CREATE
docId	UUID	문서 아이디	예
name	문자열	태그 이름	예	태그 01
description	문자열	태그 설명	아니오
pdf	boolean	PDF 파일 만들기 여부. 기본 값은 false입니다.	아니오	true \| false
pdfThemeId	UUID	PDF 테마 아이디	아니오
pdfPageLayoutId	UUID	PDF 페이지 레이아웃 아이디	아니오
epub	boolean	EPUB 파일 만들기 여부. 기본 값은 false입니다.	아니오	true \| false
epubThemeId	UUID	EPUB 테마 아이디	아니오
html	boolean	HTML 파일 만들기 여부. 기본 값은 false입니다.	아니오	true \| false
htmlThemeId	UUID	HTML 테마 아이디	아니오
htmlViewerLayoutId	UUID	HTML 뷰어 레이아웃 아이디	아니오
word	boolean	WORD 파일 만들기 여부. 기본 값은 false입니다.	아니오	true \| false
wordThemeId	UUID	MS 워드 테마 아이디	아니오

예제는 다음과 같습니다.

{
	"action": "TAG_CREATE",
    "docId": "124084a9aada2a03",
    "name": "태그 01",
    "pdf": true,
	"pdfThemeId": "11d88028b00f363b",
	"pdfPageLayoutId": "5f88fb42080ecdc0"
}

다음을 참고합니다.

문서 크기와 파일 만들기 선택에 따라서 태그를 만드는 데 오래 걸릴 수 있습니다. 타임 아웃 제한이 없으며, 오류가 발생하지 않는 한 태그 만들기가 끝날 때까지 기다립니다.

API 응답

`TAG_CREATE` 응답

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

`TAG_CREATE` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
tag	Tag 객체	태그	예

`Tag` 객체

`Tag` 객체
이름	유형	설명	필수 여부	예
id	UUID	태그 아이디	예	b7ebeaa3c2cfcddf
name	문자열	태그 이름	예	태그 01
description	문자열	태그 설명	아니오
time	long	태그를 만든 시간	예
pdf	문자열	PDF 내려받기 URL	아니오
epub	문자열	EPUB 내려받기 URL	아니오
html	문자열	HTML 내려받기 URL	아니오
word	문자열	WORD 내려받기 URL	아니오

예외 항목

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

예외	설명
API_HAS_NOT_DOC	API에 해당 문서를 포함시키지 않았을 때
DOC_NOT_EXIST	문서가 존재하지 않을 때
EPUB_BUILD_FAILED	EPUB 파일 만들기에서 오류가 발생했을 때
EPUB_THEME_NOT_EXIST	EPUB 테마가 존재하지 않을 때
EPUB_THEME_UNCONFIGURED	EPUB 테마를 설정하지 않았을 때
EPUB_THEME_UNSUPPORTED	EPUB 테마가 웹 테마가 아닐 때
HTML_BUILD_FAILED	HTML 파일 만들기에서 오류가 발생했을 때
HTML_VIEWER_LAYOUT_NOT_EXIST	HTML 뷰어 레이아웃이 존재하지 않을 때
HTML_VIEWER_LAYOUT_UNCONFIGURED	HTML 뷰어 레이아웃을 설정하지 않았을 때
HTML_THEME_NOT_EXIST	HTML 테마가 존재하지 않을 때
HTML_THEME_UNCONFIGURED	HTML 테마를 설정하지 않았을 때
HTML_THEME_UNSUPPORTED	HTML 테마가 웹 테마가 아닐 때
PDF_BUILD_FAILED	PDF 파일 만들기에서 오류가 발생했을 때
PDF_PAGE_LAYOUT_NOT_EXIST	PDF 페이지 레이아웃이 존재하지 않을 때
PDF_PAGE_LAYOUT_UNCONFIGURED	PDF 페이지 레이아웃을 설정하지 않았을 때
PDF_THEME_NOT_EXIST	PDF 테마가 존재하지 않을 때
PDF_THEME_UNCONFIGURED	PDF 테마를 설정하지 않았을 때
PDF_THEME_UNSUPPORTED	PDF 테마가 PDF 테마가 아닐 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
INVALID_PARAMETER	문자열의 길이 등이 형식에 맞지 않을 때
WORD_BUILD_FAILED	MS 워드 파일 만들기에서 오류가 발생했을 때
WORD_THEME_NOT_EXIST	MS 워드 테마가 존재하지 않을 때
WORD_THEME_UNCONFIGURED	MS 워드 테마를 설정하지 않았을 때
WORD_THEME_UNSUPPORTED	MS 워드 테마가 PDF 테마가 아닐 때

예제

예제입니다.

{
	"status": "success",
	"tag": {
		"id": "b7ebeaa3c2cfcddf",
	    "name": "태그 01",
    	"pdf" : "http://127.0.0.1:1975/pdf/download/b7ebeaa3c2cfcddf",
    	"html" : "http://127.0.0.1:1975/html/download/b7ebeaa3c2cfcddf"
    }
}