Twinreader API 사용하기 3

아티클 관련 제품: Twinreader2.0

들어가며

• 기존에 분석 결과가 존재하는 경우 API를 통해 결과가 추출될 때 기존 결과에  overwrite 되기 때문에 별도 경로에 옮긴 후 사용하시기 바랍니다.
• Twinreader API 사용하기 2 에 이어 API의 종류 중 아래의 3개 항목에 대해 알아보겠습니다.
  • Template 결과 추출 요청
  • Detection 결과 요청
  • 기준 정보 갱신 요청

API 사용 방법

• 각 요청에 맞는 URL과 data를 넣어서 curl 명령어를 사용하여 호출합니다.

Curl 명령어 전송하기

curl [Server IP]:port / [API URL]  \ -- header "Content-Type: application/json" \ --data {      [요청 구조에서 필수 / 선택으로 정의되어 있는 Parameter] }

Template 결과 추출 요청

• 지정한 template로 분석한 결과를 추출하는 API 입니다.

API 형식

Protocol	전송방식	Header	URL
http	Post	{"Content-Type": "application/json"}	/twinreader-mgr-service/api/v1/template/extract/path
요청 코드
curl http://Server_IP_주소/twinreader-mgr-service/api/v1/template/extract/path \ --request POST \ --header "Content-Type: application/json" \ --data '{"imagePath": ["/Image_Sample.jpg"], "templateName": "공통"}'

요청 구조

필수 / 선택	Parameter	타입	설명
필수	imagePath	String	분석 이미지 경로
선택	templateName	String	분석 데이터에 적용할 template 이름
선택	templateList	Array	다중 페이지를 위한 복수 template 이름 페이지 수보다 template의 수가 적다면 첫 번째 선언된 template가 적용되어 추출

요청 json 예시

결과 json 예시

{
    "resultPath": "dir/testImage_png/templateJson/testImage_png_template_result.json",
    "success": true,
    "message": ""
}

결과 message 종류

Error Message	설명
Classification JSON Read Fail	Classification 파일을 읽을 수 없습니다.
TemplateName is not defined in Classification.json	Classification 파일에 templateName이 정의되지 않았습니다.
Template Error - Object Create Fail	Template error - 객체 생성에 실패했습니다.

Detection 결과 요청

• 단일 건에 대한 detection 결과를 요청하는 API입니다.

API 형식

Protocol	전송방식	Header	URL
http	Get	{"Content-Type": "application/json"}	/twinreader-mgr-service/api/v1/template/rawDataResult
요청 코드
curl http://Server_IP_주소/twinreader-mgr-service/api/v1/template/rawDataResult \ --data-urlencode "image=sample_image_1.jpg"

요청 구조

필수 / 선택	Parameter	타입	설명
필수	image	String	요청 할 대상 이미지
선택	dir	String	대상 이미지의 디렉토리

요청 Query 예시

결과 json 예시

마무리

• API를 사용하여 분석 결과를 받는 방법에 대해 알아보았습니다.