OCR

공통 설정

인증키 발급

인증 토근 발급받기 위한 계정 생성 이름, 이메일, 패스워드 입력 후 계정을 생성 해야만 정상적으로 사용이 가능합니다.

토큰 발급을 위한 로그인

이메일 / 패스워드 입력 토큰 값 발급 후 인증 통해 정상적으로 API 를 이용 하실 수 있습니다.

발급 토큰 유효

토큰은 발급 1시간 후 자동 파기 됩니다. 재발급 받으셔야 정상 이용 가능합니다.

API URL

Method	Request URI
POST	/api/v1/ocr

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer [토큰값]
Content-Type	application/json

요청 파라미터

파라미터 이름	타입	설명	기본값	필수 여부
version	String	버전 정보 필수로 V1, 혹은 V2를 입력. V2 사용을 권장하며, V2사용시 boundingPoly 정보가 제공됨	N	Y
requestId	String	API 호출 UUID	N	Y
timestamp	0	API 호출 Timestamp	N	Y
lang	String	OCR 인식시 요청할 언어 정보	N	N
images	String	Json array로 입력되며, 현재는 1개의 이미지 입력만 허용 (한국어/일본어)	N	Y
images.format	String	이미지 포맷 설정	N	Y
images.url	String	images.url 혹은 images.data 중 하나가 존재해야 함	N	N
images.data	String	images.url 혹은 images.data 중 하나가 존재해야 함 (URL과 데이터가 모두 존재하면 데이터를 사용하고 URL은 무시)	N	N
images.name	String	이미지 명 입력. 이미지를 식별하는데 사용되며, 응답 결과 확인에 사용됨	N	Y

응답 바디

필드 이름	타입	설명
uid	String	API의 유효성을 검사하기 위해 제공되는 고유 ID로, 유효성 검사 요청을 추적하는 데 사용
name	String	요청한 이미지 이름
inferResult	String	이미지 추론 결과 “SUCCESS“: 이미지 인식 성공 “FAILURE”: 이미지 인식 실패 “ERROR”: Image recognition exception.
message	String	이미지 인식 성공 시 "SUCCESS" 이미지 인식 실패의 경우 오류 메시지가 표시됨 오류 메시지는 하단에 자세하게 안내
matchedTemplate	Json object	이미지 인식에 일치한 템플릿 정보로 템플릿 ID와 이름 포함 추론이 실패하거나 일치하는 템플릿을 찾을 수없는 경우 이 필드에 응답하지 않음
matchedTemplate.id	0	템플릿 ID
matchedTemplate.name	String	템플릿의 이름
title	String	이미지 타이틀
fields	Json array object	ImageField 객체 참조
validationResult	Json object	유효성 검사 결과
validationResult.result	String	결과 코드 “NO_REQUESTED”: 검증 작업이 실행되지 않았음 “UNCHECKED”: 동작 응답이 확인되지 않았거나 응답이 수락되지 않음 “ERROR”: 검증 실행에 오류 발생 “VALID”: 검증 결과가 유효함 “INVALID”: 검증 결과가 유효하지 않음 “UNCHECHED”,“ERROR”및“INVALID”는 유효성 검사 실패로 표시됨
validationResult.message	String	Validation 세부 메시지로 항상 응답되는 값은 아님
combineResult	Json object	판독 결과 결합
combineResult.name	String	결합 필드 이름
combineResult.text	String	각 필드 별 출력 값+고정 TEXT

오류 코드

# JSON
 
{
  "error": {
    "errorCode": "300",
    "message": "Not Found Exception"
  }
}

공통 오류

HttpStatusCode	ErrorCode	ErrorMessage	Description
400	100	Bad Request Exception	protocol(https), endocing(UTF-8) 등 request 오류
401	200	Authentication Failed	인증실패
401	210	Permission Denied	권한없음
404	300	Not Found Exception	권한없음
429	400	Quota Exceeded	Quota 초과
429	410	Throttle Limited	Rate 초과
429	420	Rate Limited	Rate 초과
413	430	Request Entity Too Large	content-length 초과 (10MB)
503	500	Endpoint Error	엔드포인트 연결오류
504	510	Endpoint Timeout	엔드포인트 연결시간 초과
500	900	Unexpected Error	예외처리가 안된 오류

Swagger 문서

Swagger 바로가기