# 웹페이지 캡처+텍스트 좌표 입력한 URL의 전체 화면 캡처 이미지와, 화면에 보이는 제목·문단·목록·표의 글자와 좌표를 함께 돌려줍니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/web_capture_extract 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.page` (object): 조회한 리뷰 페이지 번호입니다. 1부터 시작합니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.page.url` (string): http·https로 시작하는 전체 URL입니다. 대상 페이지를 앱에서 바로 열 수 있으며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.page.title` (string): 대상의 제목 또는 이름입니다. 서비스에 따라 상품명·영상 제목·페이지 제목을 뜻하며, 줄바꿈·이모지가 포함될 수 있습니다. - `data.page.viewport` (object): 'viewport' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.page.viewport.width` (integer): 이미지·영상의 가로 크기(픽셀)입니다. 화면 배치 전에 원본 비율을 확인하세요. - `data.page.viewport.height` (integer): 이미지·영상의 세로 크기(픽셀)입니다. width와 함께 원본 비율을 계산할 수 있습니다. - `data.page.document_size` (object): 'document_size' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.page.document_size.width` (integer): 이미지·영상의 가로 크기(픽셀)입니다. 화면 배치 전에 원본 비율을 확인하세요. - `data.page.document_size.height` (integer): 이미지·영상의 세로 크기(픽셀)입니다. width와 함께 원본 비율을 계산할 수 있습니다. - `data.blocks` (array): 화면에 보이는 글자 블록입니다. 각 항목에 tag(h1·p·li·td 등), text, x, y, width, height가 들어 있습니다. - `data.blocks[].tag` (string): 'tag' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.blocks[].text` (string): 'text' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.blocks[].x` (integer): 'x' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.blocks[].y` (integer): 'y' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.blocks[].width` (integer): 이미지·영상의 가로 크기(픽셀)입니다. 화면 배치 전에 원본 비율을 확인하세요. - `data.blocks[].height` (integer): 이미지·영상의 세로 크기(픽셀)입니다. width와 함께 원본 비율을 계산할 수 있습니다. - `data.block_count` (integer): 돌려준 글자 블록 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.truncated` (boolean): 글자 블록이 200개를 넘어 잘렸으면 true입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. - `data.image_base64` (string): JPEG 이미지를 base64로 담은 값입니다. 2MB를 넘으면 null이고 warnings에 안내가 들어갑니다. null 허용. - `data.image_bytes` (integer): 이미지 크기(바이트)입니다. 이미지를 싣지 않았으면 0입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.image_format` (string): 이미지 형식입니다. 항상 jpeg입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.full_page` (boolean): 전체 페이지를 담았으면 true입니다. 크기 때문에 화면에 보이는 영역만 담으면 false입니다. - `data.warnings` (array): 이미지를 싣지 못한 이유 같은 안내 문구입니다. 없으면 빈 배열입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요. - `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요. - `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다. - `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.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. - `api.pl_id` (integer): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다. ## API 요청: POST /rest/web_capture_extract ### 입력 - `url` (string, 필수): 조회할 대상의 URL입니다. http·https를 포함한 전체 주소를 보내며, 서비스에 따라 영상 ID만 받을 수도 있습니다. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "page": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "viewport": { "type": "object", "properties": { "width": { "type": "integer" }, "height": { "type": "integer" } } }, "document_size": { "type": "object", "properties": { "width": { "type": "integer" }, "height": { "type": "integer" } } } }, "description": "연 페이지 정보입니다. url, title, viewport(창 너비·높이), document_size(문서 전체 너비·높이)가 들어 있습니다." }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "text": { "type": "string" }, "x": { "type": "integer" }, "y": { "type": "integer" }, "width": { "type": "integer" }, "height": { "type": "integer" } } }, "description": "화면에 보이는 글자 블록입니다. 각 항목에 tag(h1·p·li·td 등), text, x, y, width, height가 들어 있습니다." }, "block_count": { "type": "integer", "description": "돌려준 글자 블록 수입니다." }, "truncated": { "type": "boolean", "description": "글자 블록이 200개를 넘어 잘렸으면 true입니다." }, "image_base64": { "type": "string", "description": "JPEG 이미지를 base64로 담은 값입니다. 2MB를 넘으면 null이고 warnings에 안내가 들어갑니다.", "nullable": true }, "image_bytes": { "type": "integer", "description": "이미지 크기(바이트)입니다. 이미지를 싣지 않았으면 0입니다." }, "image_format": { "type": "string", "description": "이미지 형식입니다. 항상 jpeg입니다." }, "full_page": { "type": "boolean", "description": "전체 페이지를 담았으면 true입니다. 크기 때문에 화면에 보이는 영역만 담으면 false입니다." }, "warnings": { "type": "array", "items": {}, "description": "이미지를 싣지 못한 이유 같은 안내 문구입니다. 없으면 빈 배열입니다." }, "success": { "type": "integer" }, "error": { "type": "string", "description": "실패 사유 문구입니다. 정상 응답에는 없습니다." } }, "description": "캡처 결과 묶음입니다. 실패하면 아래 필드 대신 error 문구가 들어 있습니다." }, "api": { "type": "object", "properties": { "success": { "type": "boolean" }, "cost": { "type": "integer", "description": "이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다." }, "ms": { "type": "integer", "description": "요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다." }, "pl_id": { "type": "integer" } }, "description": "호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다." } } } ``` ### 정적 응답 예시 ```json { "data": { "page": { "url": "https://example.com/", "title": "예시 페이지", "viewport": { "width": 1280, "height": 720 }, "document_size": { "width": 1280, "height": 2410 } }, "blocks": [ { "tag": "h1", "text": "예시 페이지", "x": 64, "y": 120, "width": 420, "height": 48 }, { "tag": "p", "text": "첫 문단입니다.", "x": 64, "y": 188, "width": 980, "height": 24 } ], "block_count": 2, "truncated": false, "image_base64": "/9j/4AAQSkZJRgABAQ...", "image_bytes": 184320, "image_format": "jpeg", "full_page": true, "warnings": [], "success": 1 }, "api": { "success": true, "cost": 20, "ms": 6120, "pl_id": 50233 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/web_capture_extract' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'url=https://example.com' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("url", "https://example.com"); const response = await fetch("https://apick.app/rest/web_capture_extract", { 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 parts = [ ("url", (None, "https://example.com")), ] response = requests.request("POST", "https://apick.app/rest/web_capture_extract", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php 'https://example.com', ]; $curl = curl_init('https://apick.app/rest/web_capture_extract'); 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); ``` ## 사용 예시 1. 화면 위에 글자 위치 표시하기 캡처 이미지 위에 문단·제목 위치를 사각형으로 표시할 때 씁니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/web_capture_extract' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'url=https://example.com' ``` - `data.image_base64`를 JPEG로 디코딩한 뒤 `data.blocks[].x`·`y`·`width`·`height`를 그대로 그립니다. - 좌표는 `data.page.document_size` 기준 문서 좌표입니다. 화면 좌표가 아닙니다. ## 사용 예시 2. 긴 페이지 구조 파악 한 화면에 다 들어가지 않는 긴 페이지의 제목·문단 배치를 표로 정리할 때 씁니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/web_capture_extract' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'url=https://example.com/long-page' ``` - `data.truncated`가 true이면 글자 블록이 200개를 넘은 것이므로 위쪽 블록부터 다룹니다. - `data.full_page`가 false이면 이미지가 커서 화면 영역만 담긴 것이므로 `data.page.viewport`를 기준으로 봅니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 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 } } ``` ## 상세 기능·요금 제공 정보 주소 하나를 보내면 전체 화면 이미지와, 화면에 보이는 제목·문단·목록·표의 글자와 위치를 함께 돌려줍니다. 좌표는 전체 화면 이미지와 같은 기준(문서 기준)이라 이미지 위에 그대로 표시할 수 있습니다. x·y는 왼쪽 위 꼭짓점입니다. 글자는 화면 구조에서 읽습니다. 이미지 속 글자를 판독하는 방식이 아니므로 좌표와 글자가 어긋나지 않습니다. Method URL POST https://apick.app/rest/web_capture_extract ## 상세 요청 Header 이름 필수 설명 Authorization 필수 Bearer 인증키. 예: Authorization: Bearer 발급받은_API_키 ## 상세 응답 Body 필드 타입 설명 data Object 캡처 결과 묶음입니다. 실패하면 아래 필드 대신 error 문구가 들어 있습니다. page Object 연 페이지 정보입니다. url, title, viewport(창 너비·높이), document_size(문서 전체 너비·높이)가 들어 있습니다. blocks Array 화면에 보이는 글자 블록입니다. 각 항목에 tag(h1·p·li·td 등), text, x, y, width, height가 들어 있습니다. block_count Integer 돌려준 글자 블록 수입니다. truncated Boolean 글자 블록이 200개를 넘어 잘렸으면 true입니다. image_base64 String | null JPEG 이미지를 base64로 담은 값입니다. 2MB를 넘으면 null이고 warnings에 안내가 들어갑니다. image_bytes Integer 이미지 크기(바이트)입니다. 이미지를 싣지 않았으면 0입니다. image_format String 이미지 형식입니다. 항상 jpeg입니다. full_page Boolean 전체 페이지를 담았으면 true입니다. 크기 때문에 화면에 보이는 영역만 담으면 false입니다. warnings Array 이미지를 싣지 못한 이유 같은 안내 문구입니다. 없으면 빈 배열입니다. error String 실패 사유 문구입니다. 정상 응답에는 없습니다. api Object 호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다. cost Integer 이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다. ms Integer 요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. ## 상세 코드·정책 오류 응답 HTTP data.error 원인·조치 400 URL 형식이 올바르지 않습니다. 주소가 없거나 주소 형태가 아닙니다. http·https로 시작하는 전체 주소를 보내세요. 400 이 호스트로는 요청할 수 없습니다. 내부망·루프백 주소입니다. 외부에 공개된 주소만 사용할 수 있습니다. 424 페이지를 캡처하지 못했습니다. 주소와 접속 가능 여부를 확인해 주세요. 접속 실패·시간 초과입니다. 잠시 후 다시 시도하세요. 오류 응답은 data.success 0, api.cost 0이며 요금이 차감되지 않습니다. ## 상세 예제 요청 예시 form-data 전체 예제 보기 응답 예시 { "data": { "page": { "url": "https://example.com/", "title": "예시 페이지", "viewport": { "width": 1280, "height": 720 }, "document_size": { "width": 1280, "height": 2410 } }, "blocks": [ { "tag": "h1", "text": "예시 페이지", "x": 64, "y": 120, "width": 420, "height": 48 }, { "tag": "p", "text": "첫 문단입니다.", "x": 64, "y": 188, "width": 980, "height": 24 } ], "block_count": 2, "truncated": false, "image_base64": "/9j/4AAQSkZJRgABAQ...", "image_bytes": 184320, "image_format": "jpeg", "full_page": true, "warnings": [], "success": 1 }, "api": { "success": true, "cost": 20, "ms": 6120, "pl_id": 50233 } } 호출 예시 같은 요청을 JavaScript와 Python으로 옮긴 예시입니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다. JavaScript 예시 form-data 전체 예제 보기 Python 예시 form-data 전체 예제 보기