Obține — Pagini CMS
Citiți datele din „Pagini CMS”. Rezultatul depinde de parametrii acestei operațiuni.
GET/api/v1/pages/{page_id}
- Autentificare
Bearer- Disponibil începând cu
- STANDARD
- Permisiuni necesare
content.page:read
Exemple de cod
Exemplu de cerere
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))
Exemplu de răspuns 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"
}
}
Cum funcționează
- Scrierile asupra paginilor includ titlul, slugul, conținutul HTML, metadatele SEO, starea publicării și domeniul de aplicare pe piețe acceptat.
- Selectați explicit limba când administrați conținutul tradus.
- PATCH modifică numai câmpurile furnizate.
- Null este permis numai acolo unde schema și contextul permit ștergerea valorii.
- Regulile existente de publicare, validare a conținutului și limitare prin plan rămân aplicabile.
Parametri
Parametrii căii
page_idȘir de caractereObligatoriuIdentificatorul paginii CMS.
Restricții
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Parametri de interogare
localeȘir de caractere nullOpționalLimba selectată pentru această cerere.
Șir de caractere:minLength:2maxLength:20market_idȘir de caractere nullOpționalIdentificatorul pieței returnat de endpointul de context.
Restricții · Șir de caractere 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeȘir de caractere nullOpționalCodul pieței returnat de endpointul de context.
Șir de caractere:minLength:1maxLength:16
Această operație nu acceptă un corp JSON.
Răspunsuri
Răspuns 200
Model complet: ApiResponse_PageDetailData_
dataPageDetailDataObligatoriuDatele unui răspuns reușit.
Câmpuri ·
databody_htmlȘir de caractere nullObligatoriuConținutul paginii în HTML.
created_atȘir de caractereObligatoriuMomentul creării.
format:"date-time"idȘir de caractereObligatoriuIdentificatorul resursei; păstrați-l în forma returnată.
is_availableValoare booleanăObligatoriuIndică dacă articolul este disponibil în acest context.
market_scopeȘir de caractereObligatoriuIndică dacă resursa se aplică tuturor piețelor sau numai celor selectate.
Restricții
enum["all", "selected"]
meta_descriptionȘir de caractere nullObligatoriuDescriere pentru motoarele de căutare, în limba selectată.
meta_keywordsTablou <Șir de caractere> nullObligatoriuCuvinte-cheie pentru motoarele de căutare, în limba selectată.
meta_titleȘir de caractere nullObligatoriuTitlu pentru motoarele de căutare, în limba selectată.
numberȘir de caractereObligatoriuNumărul comenzii sau al solicitării, destinat utilizatorilor.
publishedValoare booleanăObligatoriuIndică dacă resursa este publicată.
slugȘir de caractere nullObligatoriuSegmentul căii URL în limba selectată.
titleȘir de caractere nullObligatoriuTitlul în limba selectată.
updated_atȘir de caractereObligatoriuMomentul celei mai recente actualizări.
format:"date-time"versionNumăr întregObligatoriuVersiunea resursei folosită pentru controlul concurenței.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoriuMetadatele răspunsului.
Câmpuri ·
metaModel complet:
ContextPageMetalocaleȘir de caractereObligatoriuLimba selectată pentru această cerere.
market_codeȘir de caractereObligatoriuCodul pieței returnat de endpointul de context.
market_idȘir de caractereObligatoriuIdentificatorul pieței returnat de endpointul de context.
paginationPaginationObligatoriuMetadatele paginării prin cursor.
request_idȘir de caractereObligatoriuIdentificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength:1maxLength:100
localeȘir de caractereObligatoriuLimba selectată pentru această cerere.
market_codeȘir de caractereObligatoriuCodul pieței returnat de endpointul de context.
market_idȘir de caractereObligatoriuIdentificatorul pieței returnat de endpointul de context.
request_idȘir de caractereObligatoriuIdentificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength:1maxLength:100
paginationPaginationObligatoriuMetadatele paginării prin cursor.
request_idȘir de caractereObligatoriuIdentificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength:1maxLength:100
request_idȘir de caractereObligatoriuIdentificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.
minLength:1maxLength:100
Stare HTTP
200- Răspuns reușit Schemă
400- Cerere nevalidă
401- Autentificare necesară
403- Acces refuzat
404- Resursa nu a fost găsită
409- Conflict de versiune
422- Validare eșuată
429- Limită de cereri depășită
Alte stări HTTP (7)
405- Metodă nepermisă
413- Cerere prea mare
415- Format neacceptat
500- Eroare de server
502- Eroare de gateway API
503- Serviciu indisponibil
504- Timp de așteptare depășit
Catalog de erori: ErrorResponse
Antete
401
WWW-AuthenticateȘir de caractereOpționalSchema de autentificare cerută de server.
405
AllowȘir de caractereOpționalMetodele HTTP acceptate de această resursă.
429, 503
Retry-AfterNumăr întregOpționalÎntârzierea minimă înainte de reîncercare, în secunde.
minimum:0