콘텐츠로 건너뛰기
ShopentlyLearn

조회 — CMS 페이지

“CMS 페이지”의 데이터를 조회합니다. 결과는 이 작업의 매개변수에 따라 달라집니다.

GET/api/v1/pages/{page_id}

인증
Bearer
최소 요금제
STANDARD
필수 권한
content.page:read

코드 예제

요청 예제

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/pages/example

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/pages/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/pages/example', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

응답 예제 200

JSON
{
  "data": {
    "body_html": "<p>Example</p>",
    "created_at": "2026-01-01T12:00:00Z",
    "id": "example",
    "is_available": true,
    "market_scope": "all",
    "meta_description": "example",
    "meta_keywords": [
      "example"
    ],
    "meta_title": "example",
    "number": "example",
    "published": false,
    "slug": "example",
    "title": "example",
    "updated_at": "2026-01-01T12:00:00Z",
    "version": 1
  },
  "meta": {
    "locale": "en",
    "market_code": "PL",
    "market_id": "example",
    "request_id": "example"
  }
}

작동 방식

  • 페이지 쓰기는 제목, 슬러그, HTML 본문, SEO 메타데이터, 공개 상태 및 지원하는 시장 범위를 포함합니다.
  • 번역 콘텐츠를 관리할 때 언어를 명시하세요.
  • PATCH 는 제공된 필드만 변경합니다.
  • null 은 스키마와 컨텍스트가 값 삭제를 허용할 때만 가능합니다.
  • 기존 공개, 콘텐츠 검증, 요금제 규칙은 계속 적용됩니다.

매개변수

경로 매개변수

page_id문자열필수

CMS 페이지 식별자입니다.

제약 조건
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
예제: "example"

쿼리 매개변수

locale문자열 null선택 사항

이 요청에서 선택한 언어입니다.

문자열:minLength: 2maxLength: 20
market_id문자열 null선택 사항

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

제약 조건 · 문자열 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_code문자열 null선택 사항

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

문자열:minLength: 1maxLength: 16

이 작업은 JSON 본문을 받지 않습니다.

응답

응답 200

dataPageDetailData 필수

성공 응답의 데이터입니다.

필드 · data
body_html문자열 null필수

페이지의 HTML 본문입니다.

created_at문자열필수

생성 시각입니다.

format: "date-time"
id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다.

is_available불리언필수

현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

market_scope문자열필수

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건
enum
["all", "selected"]
meta_description문자열 null필수

선택한 언어의 검색 엔진 설명입니다.

meta_keywords배열 <문자열> null필수

선택한 언어의 검색 엔진 키워드입니다.

meta_title문자열 null필수

선택한 언어의 검색 엔진 제목입니다.

number문자열필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

published불리언필수

리소스가 공개되어 있는지 나타냅니다.

slug문자열 null필수

선택한 언어의 URL 경로 조각입니다.

title문자열 null필수

선택한 언어의 제목입니다.

updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"
version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

필드 · meta

ContextPageMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

ContextMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

PageMeta

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

RequestMeta

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100
응답 예제

HTTP 상태

200
성공 응답 스키마
400
잘못된 요청
401
인증 필요
403
권한 없음
404
리소스를 찾을 수 없음
409
버전 충돌
422
유효성 검사 실패
429
요청 한도 초과
기타 HTTP 상태 (7)
405
허용되지 않은 메서드
413
요청이 너무 큼
415
지원하지 않는 형식
500
서버 오류
502
API 게이트웨이 오류
503
서비스 이용 불가
504
시간 초과

오류 목록: ErrorResponse

헤더

401

WWW-Authenticate문자열선택 사항

서버가 요구하는 인증 방식입니다.

405

Allow문자열선택 사항

이 리소스가 지원하는 HTTP 메서드입니다.

429, 503

Retry-After정수선택 사항

재시도 전에 기다려야 하는 최소 시간(초)입니다.

minimum: 0