Antcas API

Antcas API는 여러 애플리케이션 간 데이터를 교환할 수 있게 합니다.

경고: 이 API를 사용할 때 보안을 주의하세요. TLS만 사용하고 포트를 공개적으로 접근 가능한 주소에서 절대 사용하지 마세요.

참고: API가 매 호출 시 토큰을 확인해야 하므로 시스템 부하가 증가할 수 있습니다.

API 포트 설정

프로젝트 관리에서 새로운 API 포트를 추가할 수 있습니다. 설명은 포트 프로젝트에 할당 장에서 찾을 수 있습니다.

요청을 생성하려면 토큰으로 인증해야 합니다. 토큰 생성 방법은 토큰 관리 장에서 자세히 설명합니다.

형식 및 값

API는 여러 입력 형식을 지원합니다: HTTP 쿼리, JSON 및 XML. 출력은 HTML, 텍스트, JSON 또는 XML로 이루어질 수 있습니다. 문자 인코딩은 항상 UTF-8입니다.

참고: 브라우저 요소에 의한 호출은 428(Precondition Required) 오류를 발생시킵니다. 이는 XSS 공격 방지 보호이며, 이 기능을 우회할 수 없습니다. 이는 Antcas Control의 해킹을 방지합니다.

POST 또는 PUT 요청 시 데이터는 해당 형식의 콘텐츠에 작성될 수 있습니다. 각 변수는 대소문자를 구분하므로 대문자와 소문자를 구분해야 합니다. 그러나 반환은 항상 선언된 형식으로 이루어집니다. 출력 형식을 헤더 또는 format 변수를 통해 지정할 수 있습니다. 입력 형식은 항상 자동으로 인식됩니다.

GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json

다음 형식이 헤더 및 format 변수에서 지원됩니다:

Content-Type 변수 형식
application/json json JSON
application/xml xml XML
text/plain text 텍스트
text/csv csv CSV*
(기타) html HTML

*출력 형식으로만 지원됩니다.

참고: 텍스트 및 CSV 형식에는 UTF-8 BOM이 포함됩니다. 이 변수를 bom=FALSE로 설정하여 비활성화할 수 있습니다.

여러 형식이 값에 지정되면 마지막 형식이 우선합니다:

  • HTTP 헤더(콘텐츠 유형으로 출력 형식만)
  • GET
  • POST
  • JSON/XML(POST 또는 PUT 콘텐츠로)

입력 변수

다음 변수가 전역적으로 정의됩니다.

변수 설명
format 출력 형식.
bom UTF-8 형식의 BOM. 기본값은 TRUE입니다.
key 선언된 변수만 읽습니다. 이 방법은 모든 데이터가 준비되고 나서 필터링되므로 비효율적입니다. 작은 데이터 양에서만 사용해야 합니다.
header 헤더 출력. 기본값은 TRUE입니다.
compact 모든 하위 요소를 함께 결합합니다. 불리언 값이 선언되지 않으면 이 값을 사용하여 변수를 결합합니다. 그렇지 않으면 .값을 사용합니다.
values 변수 이름 대신 값만 반환합니다. 이 옵션은 HTML, CSV 및 텍스트에서만 사용할 수 있습니다.
minimal header=FALSE, compact=minimal 및 values=TRUE의 별칭입니다.
csvdel CSV 구분 기호. 기본값은 ;입니다.
csvenc CSV 포함 괄호. 기본값은 "입니다.
csvesc CSV 이스케이프 문자. 기본값은 \입니다.

다음 변수는 전역적으로 또는 개별 변수에 대해 사용할 수 있습니다. 개별 변수를 지정하려면 다음과 같이 정의합니다:

time*:hr=true

위 예제는 time으로 시작하는 모든 변수와 time 자체를 지정합니다. 모든 규칙이 순차적으로 확인됩니다. 따라서 마지막 일치하는 규칙이 우선합니다. 정규 표현식을 사용하여 검색합니다.

변수 설명
hr Human Readable. 변수가 가능한 경우 사람이 읽을 수 있는 데이터로 변환됩니다. HTML, CSV 및 텍스트 형식의 기본값은 TRUE입니다.
numdec 소수점 아래 자리 수.
numths 천 단위 구분 기호.
numdot 소수점 구분 기호.
prefix 변수 앞에 텍스트 추가.
suffix 변수 뒤에 텍스트 추가.

경로

하위 장에서는 API의 모든 응용 프로그램이 정의됩니다.

하위 페이지