개발가이드사이트 정보웹페이지 캡처+텍스트 좌표

웹페이지 캡처+텍스트 좌표 API

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

입력한 URL의 전체 화면 캡처 이미지와, 화면에 보이는 제목·문단·목록·표의 글자와 좌표를 함께 돌려줍니다.

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

알아둘 점

제공 정보

주소 하나를 보내면 전체 화면 이미지와, 화면에 보이는 제목·문단·목록·표의 글자와 위치를 함께 돌려줍니다. 좌표는 전체 화면 이미지와 같은 기준(문서 기준)이라 이미지 위에 그대로 표시할 수 있습니다. x·y는 왼쪽 위 꼭짓점입니다. 글자는 화면 구조에서 읽습니다. 이미지 속 글자를 판독하는 방식이 아니므로 좌표와 글자가 어긋나지 않습니다.

요청과 응답

API 요청
POST/rest/web_capture_extract
  • Bearer 인증
  • multipart/form-data
  • JSON 응답
요청 파라미터 1개 · 필수 1
파라미터
설명
urlstring필수
조회할 대상의 URL입니다. http·https를 포함한 전체 주소를 보내며, 서비스에 따라 영상 ID만 받을 수도 있습니다.
예시
https://example.com
응답 필드 31개
응답 필드
설명
dataobject
요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다.
data.pageobject
조회한 리뷰 페이지 번호입니다. 1부터 시작합니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.blocksarray
화면에 보이는 글자 블록입니다. 각 항목에 tag(h1·p·li·td 등), text, x, y, width, height가 들어 있습니다.
data.block_countinteger
돌려준 글자 블록 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.truncatedboolean
글자 블록이 200개를 넘어 잘렸으면 true입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다.
data.image_base64string
JPEG 이미지를 base64로 담은 값입니다. 2MB를 넘으면 null이고 warnings에 안내가 들어갑니다. null 허용.
data.image_bytesinteger
이미지 크기(바이트)입니다. 이미지를 싣지 않았으면 0입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.image_formatstring
이미지 형식입니다. 항상 jpeg입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요.
data.full_pageboolean
전체 페이지를 담았으면 true입니다. 크기 때문에 화면에 보이는 영역만 담으면 false입니다.
data.warningsarray
이미지를 싣지 못한 이유 같은 안내 문구입니다. 없으면 빈 배열입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요.
data.successinteger
업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요.
data.errorstring
오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다.
apiobject
API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다.
api.successboolean
API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다.
api.costinteger
이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다.
api.msinteger
서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다.
api.pl_idinteger
포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다.
하위 필드 14개 더 보기
응답 필드
설명
data.page.urlstring
http·https로 시작하는 전체 URL입니다. 대상 페이지를 앱에서 바로 열 수 있으며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.page.titlestring
대상의 제목 또는 이름입니다. 서비스에 따라 상품명·영상 제목·페이지 제목을 뜻하며, 줄바꿈·이모지가 포함될 수 있습니다.
data.page.viewportobject
'viewport' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.page.viewport.widthinteger
이미지·영상의 가로 크기(픽셀)입니다. 화면 배치 전에 원본 비율을 확인하세요.
data.page.viewport.heightinteger
이미지·영상의 세로 크기(픽셀)입니다. width와 함께 원본 비율을 계산할 수 있습니다.
data.page.document_sizeobject
'document_size' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다.
data.page.document_size.widthinteger
이미지·영상의 가로 크기(픽셀)입니다. 화면 배치 전에 원본 비율을 확인하세요.
data.page.document_size.heightinteger
이미지·영상의 세로 크기(픽셀)입니다. width와 함께 원본 비율을 계산할 수 있습니다.
data.blocks[].tagstring
'tag' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.blocks[].textstring
'text' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다.
data.blocks[].xinteger
'x' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.blocks[].yinteger
'y' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요.
data.blocks[].widthinteger
이미지·영상의 가로 크기(픽셀)입니다. 화면 배치 전에 원본 비율을 확인하세요.
data.blocks[].heightinteger
이미지·영상의 세로 크기(픽셀)입니다. width와 함께 원본 비율을 계산할 수 있습니다.

사용 예시

상황별로 보내는 값과 응답에서 확인할 값을 모았습니다. 언어 탭에서 그대로 복사해 쓸 수 있습니다.

예시 1. 화면 위에 글자 위치 표시하기

캡처 이미지 위에 문단·제목 위치를 사각형으로 표시할 때 씁니다.

요청POST/rest/web_capture_extract
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. 긴 페이지 구조 파악

한 화면에 다 들어가지 않는 긴 페이지의 제목·문단 배치를 표로 정리할 때 씁니다.

요청POST/rest/web_capture_extract
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를 기준으로 봅니다.

응답 처리

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

원문 응답 필드 표 보기
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
요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다.

오류 코드

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

  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
  }
}
서비스 코드·조건

오류 응답

HTTP
data.error
원인·조치
400
URL 형식이 올바르지 않습니다.
주소가 없거나 주소 형태가 아닙니다. http·https로 시작하는 전체 주소를 보내세요.
400
이 호스트로는 요청할 수 없습니다.
내부망·루프백 주소입니다. 외부에 공개된 주소만 사용할 수 있습니다.
424
페이지를 캡처하지 못했습니다. 주소와 접속 가능 여부를 확인해 주세요.
접속 실패·시간 초과입니다. 잠시 후 다시 시도하세요.
오류 응답은 data.success 0, api.cost 0이며 요금이 차감되지 않습니다.
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
무료 포인트로 사용할 수 없는 서비스입니다.
200
최소 1회 결제 후 이용할 수 있습니다. result.error 전체 문구를 그대로 표시하세요.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금기본 단가 20P · 건당무료 포인트로는 이용할 수 없으며 최소 1회 결제 후 이용할 수 있습니다.

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

연동 팁

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

{
    "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 예시
Python 예시

개발가이드 검색

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

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