임의의 문서를 PDF 또는 HTML로 생성하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “BUILD_DOC” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다.
만들 파일 1유형(PDF 또는 HTML)을 선택합니다.
API 요청
GET 형식으로 요청해야 합니다.
요청 URL 형식입니다.
/r/api/${uuid}URL 파라미터 항목입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
uuid | UUID | API UUID | 예 | 5b969d63e97cfec7 |
요청 URL 예제입니다.
/r/api/5b969d63e97cfec7
API 응답
BUILD_DOC 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
result | Doc 객체 배열 | 문서 별 빌드 결과 | 아니오 | |
errors | Error 객체 배열 | 예외 | 아니오 |
Doc 객체
문서별 빌드 결과를 표시합니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | 문서 UUID | 예 | 9b42c660300987f6 |
title | 문자열 | 문서 제목 | 예 | 매뉴얼웍스 설치 가이드 |
PDF 빌드 결과 | 아니오 | |||
html | HTML 빌드 결과 | 아니오 |
Result 객체
빌드 결과를 표시합니다.
이름 | 유형 | 설명 | 필수 | 예 |
|---|---|---|---|---|
result | boolean | 성공했을 때 | 아니오 | |
errors | Error 객체 배열 | 예외 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
UNCONFIGURED_THEME | 테마를 설정하지 않았을 때 |
UNCONFIGURED_LAYOUT | 레이아웃을 설정하지 않았을 때 |
예제
예제입니다.
{
"status": "success",
"result": [
{
"id": "128b3a5682898358",
"title": "쓰리래빗츠 북 4.0 관리자 가이드",
"pdf": {
"result": true
}
},
{
"id": "99ed0b35de59b733",
"title": "쓰리래빗츠 북 4.0 사용자 가이드",
"pdf": {
"errors": [
{"type": "UNCONFIGURED_THEME"},
{"type": "UNCONFIGURED_LAYOUT"}
]
}
}
]
}