API 만들기

API 만들기

다음 순서로 <도구 | API> 메뉴에서 필요한 API를 만듭니다.

  1. <도구 | API> 메뉴로 이동합니다. “관리” 권한이 필요합니다.

  2. <API 만들기> 링크를 클릭합니다.

  3. 기본 정보를 입력합니다.

    • 1유형을 선택합니다.

    • 2호출자를 선택합니다.

  4. <저장> 버튼을 클릭합니다.

API 호출자

API를 실행할 내부적으로는 API 호출자가 실행한 것으로 가정합니다. “관리” 권한이 있는 사용자만 호출자로 설정할 수 있습니다. API 호출 시점에 호출자에게 “관리” 권한이 있어야 합니다. 그렇지 않으면 CALLER_IS_NOT_ADMIN 예외를 반환합니다.

클라이언트 IP 설정

특정 API를 호출할 수 있는 클라이언트를 IP를 이용해서 제한할 수 있습니다. API 상세 화면에서 1클라이언트 IP를 설정합니다.

클라이언트 IP를 설정하지 않으면 모든 컴퓨터에서 해당 API를 호출할 수 있습니다.

특정 컴퓨터의 클라이언트 IP를 확인하려면 다음 주소(http://127.0.0.1:1975는 매뉴얼웍스를 설치한 서버의 도메인 정보 또는 IP 주소로 변경)를 호출합니다.

http://127.0.0.1:1975/r/api/client_ip

JSON 응답 결과는 다음과 같습니다.

{
	"ip": "127.0.0.1"
}

API 호출 URL

API 상세 화면의 1URL을 호출합니다. API마다 세부 항목이 다를 수 있습니다.

API 호출 공통 예외 항목

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

예외

설명

ACTION_REQUIRED

Action을 설정하지 않았을 때

CALLER_IS_NOT_ADMIN

호출자가 “관리” 권한이 없을 때

NOT_ALLOWED_CLIENT_IP

해당 클라이언트에서 API를 호출할 수 없을 때

UNKNOWN_ACTION

Action이 존재하지 않을 때

UNKNOWN_API

API가 존재하지 않을 때

UNKNOWN_CALLER

호출자가 존재하지 않을 때

UNSUPPORTED_ACTION

해당 API가 지원하지 않는 Action일 때

UNSUPPORTED_HTTP_METHOD

GET 또는 POST 방식으로 호출해야 하는 API를 다른 방식으로 호출했을 때