Načítať — Stránky CMS
Načítajte údaje z „Stránky CMS“. Výsledok závisí od parametrov tejto operácie.
GET/api/v1/pages/{page_id}
- Overovanie
Bearer- Dostupné od plánu
- STANDARD
- Požadované oprávnenia
content.page:read
Príklady kódu
Príklad požiadavky
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))
Príklad odpovede 200
{
"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"
}
}
Ako to funguje
- Zápisy stránok zahŕňajú názov, slug, obsah HTML, metaúdaje SEO, stav zverejnenia a podporovaný rozsah trhov.
- Pri správe preloženého obsahu výslovne vyberte jazyk.
- PATCH mení iba odovzdané polia.
- Hodnota null je povolená len tam, kde schéma a kontext dovoľujú vymazanie hodnoty.
- Naďalej platia pravidlá zverejňovania, validácie obsahu a plánu.
Parametre
Parametre cesty
page_idReťazecPovinnéIdentifikátor stránky CMS.
Obmedzenia
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Parametre dopytu
localeReťazec nullVoliteľnéJazyk vybraný pre túto požiadavku.
Reťazec:minLength:2maxLength:20market_idReťazec nullVoliteľnéIdentifikátor trhu vrátený koncovým bodom kontextu.
Obmedzenia · Reťazec 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeReťazec nullVoliteľnéKód trhu vrátený koncovým bodom kontextu.
Reťazec:minLength:1maxLength:16
Táto operácia neprijíma telo JSON.
Odpovede
Odpoveď 200
Úplný model: ApiResponse_PageDetailData_
dataPageDetailDataPovinnéObsah úspešnej odpovede.
Polia ·
databody_htmlReťazec nullPovinnéObsah stránky vo formáte HTML.
created_atReťazecPovinnéČas vytvorenia.
format:"date-time"idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.
is_availableLogická hodnotaPovinnéČi je položka v tomto kontexte dostupná.
market_scopeReťazecPovinnéČi zdroj platí pre všetky alebo len vybrané trhy.
Obmedzenia
enum["all", "selected"]
meta_descriptionReťazec nullPovinnéOpis pre vyhľadávače vo vybranom jazyku.
meta_keywordsPole <Reťazec> nullPovinnéKľúčové slová pre vyhľadávače vo vybranom jazyku.
meta_titleReťazec nullPovinnéTitulok pre vyhľadávače vo vybranom jazyku.
numberReťazecPovinnéČíslo objednávky alebo zákazníckej žiadosti určené pre používateľa.
publishedLogická hodnotaPovinnéČi je zdroj zverejnený.
slugReťazec nullPovinnéÚsek cesty URL vo vybranom jazyku.
titleReťazec nullPovinnéNázov vo vybranom jazyku.
updated_atReťazecPovinnéČas poslednej aktualizácie.
format:"date-time"versionCelé čísloPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Polia ·
metalocaleReťazecPovinnéJazyk vybraný pre túto požiadavku.
market_codeReťazecPovinnéKód trhu vrátený koncovým bodom kontextu.
market_idReťazecPovinnéIdentifikátor trhu vrátený koncovým bodom kontextu.
paginationPaginationPovinnéMetaúdaje stránkovania pomocou kurzora.
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
localeReťazecPovinnéJazyk vybraný pre túto požiadavku.
market_codeReťazecPovinnéKód trhu vrátený koncovým bodom kontextu.
market_idReťazecPovinnéIdentifikátor trhu vrátený koncovým bodom kontextu.
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
paginationPaginationPovinnéMetaúdaje stránkovania pomocou kurzora.
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
Stav HTTP
200- Úspešná odpoveď Schéma
400- Neplatná požiadavka
401- Vyžaduje sa overenie
403- Prístup zamietnutý
404- Zdroj sa nenašiel
409- Konflikt verzií
422- Chyba validácie
429- Prekročený limit požiadaviek
Ďalšie stavy HTTP (7)
405- Metóda nie je povolená
413- Príliš veľká požiadavka
415- Nepodporovaný formát
500- Chyba servera
502- Chyba brány API
503- Služba nedostupná
504- Vypršal časový limit
Katalóg chýb: ErrorResponse
Hlavičky
401
WWW-AuthenticateReťazecVoliteľnéSpôsob overenia požadovaný serverom.
405
AllowReťazecVoliteľnéMetódy HTTP podporované týmto zdrojom.
429, 503
Retry-AfterCelé čísloVoliteľnéMinimálne oneskorenie pred opakovaním v sekundách.
minimum:0