CLOVA OCR 개요

공통 설정

본 문서에서는 CLOVA OCR 상품별 호출 URL 및 헤더 설정 방법, 공통 에러 코드에 대해 설명합니다.

참고

각 상품별 API 세부사항은 아래 문서를 참조해 주십시오.

API URL 예시

http://clovaocr-api.gov-ncloud.com/external/v1/12345/db6***

API URL 상세

메소드	설명
POST	CLOVA OCR 빌더에서 생성한 도메인별 Invoke URL 각 도메인마다 고유한 Invoke URL이 생성됨

메소드

설명

POST

CLOVA OCR 빌더에서 생성한 도메인별 Invoke URL
각 도메인마다 고유한 Invoke URL이 생성됨

헤더 상세

헤더명	설명
X-OCR-SECRET	NCP 콘솔에서 생성한 도메인의 API Gateway 버튼을 클릭하여 `X-OCR-SECRET:{Client Secret}` 값을 확인 후 해당 값을 설정
Content-Type	`application/json` : 요청 바디가 JSON일 경우 설정, BASE64 인코딩 된 images.url 또는 images.data 지원 `multipart/form-data` : 요청 바디가 form-data일 경우 설정, 스트리밍으로 전송되는 이미지 파일 지원

헤더명

설명

X-OCR-SECRET

NCP 콘솔에서 생성한 도메인의 API Gateway 버튼을 클릭하여 X-OCR-SECRET:{Client Secret} 값을 확인 후 해당 값을 설정

Content-Type

application/json : 요청 바디가 JSON일 경우 설정, BASE64 인코딩 된 images.url 또는 images.data 지원

multipart/form-data : 요청 바디가 form-data일 경우 설정, 스트리밍으로 전송되는 이미지 파일 지원

헤더명	설명
x-ncp-apigw-timestamp	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`

헤더명

설명

x-ncp-apigw-timestamp

1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-timestamp:{Timestamp}

x-ncp-iam-access-key

네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Sub Account Access Key}

x-ncp-apigw-signature-v2

Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v2:{API Gateway Signature}

에러코드

에러 응답 예시

{ "code": "0001", "message": "URL is invalid.", "path": "{request API path}", "traceId": "{traceId}", "timestamp": {timestamp} }

상태 코드 상세

HTTPS 상태 코드	설명
400	요청 매개변수가 유효하지 않거나 제약 조건에 문제가 있습니다.
401	잘못된 API secret key (X-OCR-API-KEY) 입니다.
500	내부 서버 오류가 발생하였습니다.

HTTPS 상태 코드

설명

400

요청 매개변수가 유효하지 않거나 제약 조건에 문제가 있습니다.

401

잘못된 API secret key (X-OCR-API-KEY) 입니다.

500

내부 서버 오류가 발생하였습니다.

에러코드 상세

에러코드	에러 메시지	설명
0001	URL is invalid.	유효하지 않은 호출 URL, 호출한 POST URL이 정확한지 확인 필요
0002	Secret key validate failed.	Secret Key 검증 실패, 올바른 `X-OCR-SECRET:{Client Secret}` 값을 입력했는지 확인 필요
0011	Request body invalid.	요청 바디 형식이 문법에 맞지 않음
0021	Protocol version not support.	지원하지 않는 API 버전
0022	Request domain invalid.	요청 도메인이 올바르지 않음
0023	API request count reach the upper limit.	API 호출 제한에 도달함
0025	Calls to this api have exceeded the rate limit.	API 호출 수가 요금 제한(Rate Limit)을 초과함
0500	Unknown service error.	알 수 없는 서비스 에러가 발생
0501	OCR service error.	OCR 서비스 에러가 발생
1021	Not found deploy infomation. Please confirm the template is released.	Template 배포 이력을 찾을 수 없음, NCP 콘솔의 도메인에 Template이 배포되었는지 확인 필요

에러코드

에러 메시지

설명

0001

URL is invalid.

유효하지 않은 호출 URL, 호출한 POST URL이 정확한지 확인 필요

0002

Secret key validate failed.

Secret Key 검증 실패, 올바른 X-OCR-SECRET:{Client Secret} 값을 입력했는지 확인 필요

0011

Request body invalid.

요청 바디 형식이 문법에 맞지 않음

0021

Protocol version not support.

지원하지 않는 API 버전

0022

Request domain invalid.

요청 도메인이 올바르지 않음

0023

API request count reach the upper limit.

API 호출 제한에 도달함

0025

Calls to this api have exceeded the rate limit.

API 호출 수가 요금 제한(Rate Limit)을 초과함

0500

Unknown service error.

알 수 없는 서비스 에러가 발생

0501

OCR service error.

OCR 서비스 에러가 발생

1021

Not found deploy infomation. Please confirm the template is released.

Template 배포 이력을 찾을 수 없음, NCP 콘솔의 도메인에 Template이 배포되었는지 확인 필요

CLOVA OCR 개요

개요

공통 설정

API URL 예시

API URL 상세

헤더 상세

에러코드

에러 응답 예시

상태 코드 상세

에러코드 상세

What's Next