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



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



인증: Authorization: Bearer $APICK_API_KEY

본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다.

인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다.



## POST /rest/ocr/test 응답 필드

- `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.

- `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.

- `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.

- `data.error_code` (string): 'error_code' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.

- `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.

- `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.

- `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.

- `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.

- `api.pl_id` (string): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.

- `api.test` (boolean): 테스트 응답임을 나타내는 true가 들어 있습니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.

## API 요청: POST /rest/ocr/test



### 입력

- `test_case` (string, 선택): 돌려받을 응답 종류입니다. 비워 두거나 success를 보내면 정상 응답, 그 밖의 값(예: error)을 보내면 오류 응답 픽스처를 돌려줍니다.



### 응답 명세

```json

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

```

### 정적 응답 예시

```json

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

```

### curl

```curl

printf '%s\r\n' '--apick-empty--' | curl --fail-with-body --request POST 'https://apick.app/rest/ocr/test' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --header 'Content-Type: multipart/form-data; boundary=apick-empty' \
  --data-binary @-

```

### Node.js (서버 ESM)

```javascript

const form = new FormData();
const response = await fetch("https://apick.app/rest/ocr/test", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY },
  body: form,
  signal: AbortSignal.timeout(120_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const result = await response.json();
console.log(result);

```

### python

```python

import os
import requests
response = requests.request("POST", "https://apick.app/rest/ocr/test",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"], "Content-Type": "multipart/form-data; boundary=apick-empty"},
    data=b"--apick-empty--\r\n",
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

```

### php

```php

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$headers[] = "Content-Type: multipart/form-data; boundary=apick-empty";
$form = "--apick-empty--\r\n";
$curl = curl_init('https://apick.app/rest/ocr/test');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => $form,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120,
]);
$body = curl_exec($curl);
if ($body === false) { throw new RuntimeException(curl_error($curl)); }
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status >= 400) { throw new RuntimeException($body); }
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($result);

```

## 코드·오류

### 업무 실패 응답

입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요.

```json

{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}

```

## 상세 기능·요금

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

## 상세 요청

Header 이름 필수 설명 Authorization 필수 Bearer 인증키. 예: Authorization: Bearer 발급받은_API_키 일반 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으로 표시됩니다.

## 상세 예제

요청 예시 (정상 응답) form-data 전체 예제 보기 요청 예시 (오류 응답) form-data 전체 예제 보기 응답 예시 (오류 응답) { "data": { "success": 0, "error": "이미지에서 텍스트를 찾지 못했습니다.", "error_code": "OCR_NO_TEXT" }, "api": { "success": true, "ms": 0, "cost": 12, "pl_id": "test", "test": true } }
