본문 바로가기
개발가이드시작하기테스트 API — 모든 상품을 포인트 차감 없이 호출

테스트 API — 모든 상품을 포인트 차감 없이 호출

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

충전 전에도, 잔여 포인트와 상관없이 모든 상품의 연동을 미리 확인할 수 있습니다. 호출 주소 끝에 /test만 붙이면 정상 응답과 오류 응답을 고정 값으로 돌려받아, 연동 코드·오류 처리·응답 파싱을 실제 결과 없이 검증할 수 있습니다.

POSThttps://apick.app/rest/ocr/test
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
1개

알아둘 점

포인트 차감·이용 기록 없음. 테스트 호출은 과금되지 않고, 몇 번을 호출해도 잔여 포인트가 줄지 않습니다. 회원가입만 하면 됩니다. 결제·충전 없이, API 키가 정상인 계정이면 바로 호출할 수 있습니다. 응답 규격은 실제와 같습니다. api.cost에 상품 판매가가 표시되고 api.success는 정상 응답과 같은 모양이라, 연동 시험에 그대로 쓸 수 있습니다.
응답 데이터는 사전에 정의된 고정 값입니다. 실제 조회 결과가 아니므로 결과값 자체의 정확성 검증에는 사용하지 마세요.

호출 방법

원래 호출 주소 끝에 /test를 붙입니다. GET·POST 모두 지원하며, 인증 방식은 일반 API와 같습니다.

유의사항

테스트 호출은 과금·포인트 차감·이용 기록이 생기지 않습니다. 대량으로 호출해도 잔여 포인트는 줄어들지 않습니다. 테스트 응답의 데이터는 고정 값입니다. 상품 업데이트에 맞춰 테스트 응답도 함께 갱신되므로, 최신 계약 확인은 각 상품 문서를 기준으로 해 주세요. 실제 요금·실제 결과를 확인하려면 /test가 없는 원래 주소로 호출해야 합니다.

요청과 응답

API 요청
POST/rest/ocr/test
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 1개
파라미터
설명
test_casestring선택
돌려받을 응답 종류입니다. 비워 두거나 success를 보내면 정상 응답, 그 밖의 값(예: error)을 보내면 오류 응답 픽스처를 돌려줍니다.
응답 필드 10개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.successinteger
업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.
data.errorstring
오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.
data.error_codestring
'error_code' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.pl_idstring
포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
api.testboolean
테스트 응답임을 나타내는 true가 들어 있습니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
입력 조건·전송 규칙
일반 API의 입력 파라미터는 넣지 않아도 됩니다. 테스트 응답은 요청 입력과 무관한 고정 값이 그대로 나갑니다.

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

원문 응답 필드 표 보기
Body
필드
타입
설명
data
Object
사전에 정의된 고정 테스트 응답입니다. 정상 응답은 success: 1과 result, 오류 응답은 success: 0과 error·error_code가 들어 있습니다.
api
Object
호출 공통 정보입니다. 실제 호출과 같은 모양으로 나갑니다.
success
Boolean
항상 true입니다. 테스트 오류 응답을 받아도 호출 자체는 정상 처리된 것입니다.
cost
Integer
해당 상품의 판매가가 표시됩니다. 실제로는 차감되지 않습니다.
test
Boolean
테스트 응답임을 나타내는 true가 들어 있습니다.
ms
Integer
테스트 응답은 0으로 표시됩니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금서비스별 요금 조건 확인

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.
추가 예제·서비스별 연동 안내
요청 예시 (정상 응답)
요청 예시 (오류 응답)
응답 예시 (오류 응답)

{
	"data": {
		"success": 0,
		"error": "이미지에서 텍스트를 찾지 못했습니다.",
		"error_code": "OCR_NO_TEXT"
	},
	"api": {
		"success": true,
		"ms": 0,
		"cost": 12,
		"pl_id": "test",
		"test": true
	}
}
            

테스트 API — 모든 상품을 포인트 차감 없이 호출

충전 전에도, 잔여 포인트와 상관없이 모든 상품의 연동을 미리 확인할 수 있습니다. 호출 주소 끝에 /test만 붙이면 정상 응답과 오류 응답을 고정 값으로 돌려받아, 연동 코드·오류 처리·응답 파싱을 실제 결과 없이 검증할 수 있습니다.

포인트 차감·이용 기록 없음. 테스트 호출은 과금되지 않고, 몇 번을 호출해도 잔여 포인트가 줄지 않습니다. 회원가입만 하면 됩니다. 결제·충전 없이, API 키가 정상인 계정이면 바로 호출할 수 있습니다. 응답 규격은 실제와 같습니다. api.cost에 상품 판매가가 표시되고 api.success는 정상 응답과 같은 모양이라, 연동 시험에 그대로 쓸 수 있습니다.
응답 데이터는 사전에 정의된 고정 값입니다. 실제 조회 결과가 아니므로 결과값 자체의 정확성 검증에는 사용하지 마세요.

호출 방법

원래 호출 주소 끝에 /test를 붙입니다. GET·POST 모두 지원하며, 인증 방식은 일반 API와 같습니다.

Method
URL
POST
https://apick.app/rest/<서비스>/test
GET
https://apick.app/rest/<서비스>/test?test_case=error

요청

Header
이름
필수
설명
Authorization
필수
Bearer 인증키. 예: Authorization: Bearer 발급받은_API_키
파라미터
이름
필수
설명
test_case
선택
돌려받을 응답 종류입니다. 비워 두거나 success를 보내면 정상 응답, 그 밖의 값(예: error)을 보내면 오류 응답 픽스처를 돌려줍니다.
일반 API의 입력 파라미터는 넣지 않아도 됩니다. 테스트 응답은 요청 입력과 무관한 고정 값이 그대로 나갑니다.

응답

Body
필드
타입
설명
data
Object
사전에 정의된 고정 테스트 응답입니다. 정상 응답은 success: 1과 result, 오류 응답은 success: 0과 error·error_code가 들어 있습니다.
api
Object
호출 공통 정보입니다. 실제 호출과 같은 모양으로 나갑니다.
success
Boolean
항상 true입니다. 테스트 오류 응답을 받아도 호출 자체는 정상 처리된 것입니다.
cost
Integer
해당 상품의 판매가가 표시됩니다. 실제로는 차감되지 않습니다.
test
Boolean
테스트 응답임을 나타내는 true가 들어 있습니다.
ms
Integer
테스트 응답은 0으로 표시됩니다.

예시

요청 예시 (정상 응답)

curl -X POST "https://apick.app/rest/ocr/test" \
-H "Authorization: Bearer $API_KEY"
            
요청 예시 (오류 응답)

curl -X POST "https://apick.app/rest/ocr/test" \
-H "Authorization: Bearer $API_KEY" \
-d "test_case=error"
            
응답 예시 (오류 응답)

{
	"data": {
		"success": 0,
		"error": "이미지에서 텍스트를 찾지 못했습니다.",
		"error_code": "OCR_NO_TEXT"
	},
	"api": {
		"success": true,
		"ms": 0,
		"cost": 12,
		"pl_id": "test",
		"test": true
	}
}
            

유의사항

테스트 호출은 과금·포인트 차감·이용 기록이 생기지 않습니다. 대량으로 호출해도 잔여 포인트는 줄어들지 않습니다. 테스트 응답의 데이터는 고정 값입니다. 상품 업데이트에 맞춰 테스트 응답도 함께 갱신되므로, 최신 계약 확인은 각 상품 문서를 기준으로 해 주세요. 실제 요금·실제 결과를 확인하려면 /test가 없는 원래 주소로 호출해야 합니다.

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.