Ikseb — Paġni CMS
Aqra d-data minn “Paġni CMS”. Ir-riżultat jiddependi fuq il-parametri ta’ din l-operazzjoni.
GET/api/v1/pages/{page_id}
- Awtentikazzjoni
Bearer- Disponibbli minn
- STANDARD
- Permessi meħtieġa
content.page:read
Eżempji ta’ kodiċi
Eżempju ta’ talba
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))
Eżempju ta’ tweġiba 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"
}
}
Kif jaħdem
- Il-kitbiet tal-paġni jkopru t-titlu, is-slug, il-kontenut HTML, il-metadata SEO, l-istat tal-pubblikazzjoni u l-firxa tas-swieq appoġġata.
- Agħżel il-lingwa espliċitament meta żżomm kontenut tradott.
- PATCH ibiddel biss l-oqsma mibgħuta.
- null huwa permess biss fejn l-iskema u l-kuntest jippermettu t-tneħħija ta’ valur.
- Ir-regoli eżistenti tal-pubblikazzjoni, tal-validazzjoni tal-kontenut u tal-pjan jibqgħu japplikaw.
Parametri
Parametri tal-mogħdija
page_idStringObbligatorjuIdentifikatur tal-paġna CMS.
Restrizzjonijiet
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Parametri tal-mistoqsija
localeString nullMhux obbligatorjuLingwa magħżula għal din it-talba.
String:minLength:2maxLength:20market_idString nullMhux obbligatorjuIdentifikatur tas-suq mogħti mill-endpoint tal-kuntest.
Restrizzjonijiet · String 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeString nullMhux obbligatorjuKodiċi tas-suq mogħti mill-endpoint tal-kuntest.
String:minLength:1maxLength:16
Din l-operazzjoni ma taċċettax kontenut JSON.
Tweġibiet
Risposta 200
Mudell sħiħ: ApiResponse_PageDetailData_
dataPageDetailDataObbligatorjuData ta’ tweġiba ta’ suċċess.
Oqsma ·
databody_htmlString nullObbligatorjuKontenut tal-paġna f’HTML.
created_atStringObbligatorjuĦin tal-ħolqien.
format:"date-time"idStringObbligatorjuIdentifikatur tar-riżorsa; żommu kif mogħti.
is_availableBooleanObbligatorjuJekk l-oġġett huwiex disponibbli f’dan il-kuntest.
market_scopeStringObbligatorjuJekk ir-riżorsa tapplikax għas-swieq kollha jew għal dawk magħżula.
Restrizzjonijiet
enum["all", "selected"]
meta_descriptionString nullObbligatorjuDeskrizzjoni għall-magni tat-tiftix fil-lingwa magħżula.
meta_keywordsArray <String> nullObbligatorjuKliem ewlieni għall-magni tat-tiftix fil-lingwa magħżula.
meta_titleString nullObbligatorjuTitlu għall-magni tat-tiftix fil-lingwa magħżula.
numberStringObbligatorjuNumru tal-ordni jew tat-talba muri lill-bniedem.
publishedBooleanObbligatorjuJekk ir-riżorsa hijiex ippubblikata.
slugString nullObbligatorjuSegment tal-mogħdija URL fil-lingwa magħżula.
titleString nullObbligatorjuTitlu fil-lingwa magħżula.
updated_atStringObbligatorjuĦin tal-aktar aġġornament reċenti.
format:"date-time"versionNumru sħiħObbligatorjuVerżjoni tar-riżorsa għall-kontroll tal-konkorrenza.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorjuMetadata tat-tweġiba.
Oqsma ·
metalocaleStringObbligatorjuLingwa magħżula għal din it-talba.
market_codeStringObbligatorjuKodiċi tas-suq mogħti mill-endpoint tal-kuntest.
market_idStringObbligatorjuIdentifikatur tas-suq mogħti mill-endpoint tal-kuntest.
paginationPaginationObbligatorjuMetadata tal-paġinazzjoni bil-cursor.
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
localeStringObbligatorjuLingwa magħżula għal din it-talba.
market_codeStringObbligatorjuKodiċi tas-suq mogħti mill-endpoint tal-kuntest.
market_idStringObbligatorjuIdentifikatur tas-suq mogħti mill-endpoint tal-kuntest.
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
paginationPaginationObbligatorjuMetadata tal-paġinazzjoni bil-cursor.
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
request_idStringObbligatorjuIdentifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.
minLength:1maxLength:100
Status HTTP
200- Risposta b’suċċess Skema
400- Talba mhux valida
401- Awtentikazzjoni meħtieġa
403- Permess miċħud
404- Riżorsa ma nstabitx
409- Kunflitt tal-verżjoni
422- Validazzjoni falliet
429- Inqabeż il-limitu tat-talbiet
Stati HTTP oħra (7)
405- Metodu mhux permess
413- Talba kbira wisq
415- Format mhux appoġġjat
500- Żball tas-server
502- Żball tal-gateway tal-API
503- Servizz mhux disponibbli
504- Skada l-ħin ta’ stennija
Katalgu tal-iżbalji: ErrorResponse
Headers
401
WWW-AuthenticateStringMhux obbligatorjuSkema ta’ awtentikazzjoni meħtieġa mis-server.
405
AllowStringMhux obbligatorjuMetodi HTTP appoġġati minn din ir-riżorsa.
429, 503
Retry-AfterNumru sħiħMhux obbligatorjuDewmien minimu qabel tentattiv ieħor, f’sekondi.
minimum:0