API 만들기

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

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

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

API 요청

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

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 이름	예	DOC_UPDATE_PARAMETER
id	UUID	문서 아이디	예	0168a36b30c18e93
parameter	JSON 객체	파라미터	예

문서를 변경하는 예제입니다.

{
    "action": "DOC_UPDATE_PARAMETER",
    "id": "0168a36b30c18e93",
    "parameter": {
        "name": "매뉴얼웍스 6.0",
    	"version": "6.0.2"
    }
}

parameter 객체의 키에는 파라미터 이름을 입력합니다. 값에는 문자열로 파라미터 값을 입력합니다.

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

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

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

예제입니다.

{
	"status": "success"
}