Faigh — Leathanaigh CMS
Léigh sonraí ó “Leathanaigh CMS”. Braitheann an toradh ar pharaiméadair na hoibríochta seo.
GET/api/v1/pages/{page_id}
- Fíordheimhniú
Bearer- Ar fáil ó
- STANDARD
- Ceadanna riachtanacha
content.page:read
Samplaí cóid
Sampla iarratais
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))
Sampla freagra 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"
}
}
Conas a oibríonn sé
- Clúdaíonn scríbhinní leathanaigh teideal, sluga URL, ábhar HTML, meiteashonraí SEO, stádas foilsithe agus raon margaidh tacaithe.
- Roghnaigh an teanga go follasach agus ábhar aistrithe á chothabháil.
- Ní athraíonn PATCH ach réimsí a sholáthraítear.
- Ní cheadaítear null ach nuair a cheadaíonn an scéim agus an comhthéacs luach a ghlanadh.
- Tá rialacha foilsithe, bailíochtaithe ábhair agus plean fós i bhfeidhm.
Paraiméadair
Paraiméadair chosáin
page_idTeaghránRiachtanachAitheantóir leathanaigh CMS.
Srianta
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Paraiméadair fhiosrúcháin
localeTeaghrán nullRoghnachTeanga roghnaithe don iarratas seo.
Teaghrán:minLength:2maxLength:20market_idTeaghrán nullRoghnachAitheantóir margaidh a thugann an críochphointe comhthéacs.
Srianta · Teaghrán 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeTeaghrán nullRoghnachCód margaidh a thugann an críochphointe comhthéacs.
Teaghrán:minLength:1maxLength:16
Ní ghlacann an oibríocht seo le corp JSON.
Freagraí
Freagra 200
Samhail iomlán: ApiResponse_PageDetailData_
dataPageDetailDataRiachtanachSonraí freagra rathúil.
Réimsí ·
dataSamhail iomlán:
PageDetailDatabody_htmlTeaghrán nullRiachtanachÁbhar an leathanaigh in HTML.
created_atTeaghránRiachtanachAm cruthaithe.
format:"date-time"idTeaghránRiachtanachAitheantóir acmhainne; coinnigh mar a tugadh ar ais é.
is_availableLuach BooleRiachtanachAn bhfuil an mhír ar fáil sa chomhthéacs seo.
market_scopeTeaghránRiachtanachAn mbaineann an acmhainn le gach margadh nó le margaí roghnaithe.
Srianta
enum["all", "selected"]
meta_descriptionTeaghrán nullRiachtanachCur síos inneall cuardaigh sa teanga roghnaithe.
meta_keywordsEagar <Teaghrán> nullRiachtanachEochairfhocail inneall cuardaigh sa teanga roghnaithe.
meta_titleTeaghrán nullRiachtanachTeideal inneall cuardaigh sa teanga roghnaithe.
numberTeaghránRiachtanachUimhir ordaithe nó iarratais atá le léamh ag duine.
publishedLuach BooleRiachtanachAn bhfuil an acmhainn foilsithe.
slugTeaghrán nullRiachtanachCuid de chosán URL sa teanga roghnaithe.
titleTeaghrán nullRiachtanachTeideal sa teanga roghnaithe.
updated_atTeaghránRiachtanachAm an nuashonraithe is déanaí.
format:"date-time"versionSlánuimhirRiachtanachLeagan acmhainne a úsáidtear le haghaidh rialú comhreatha.
metaContextPageMetaContextMetaPageMetaRequestMetaRiachtanachMeiteashonraí an fhreagra.
Réimsí ·
metaSamhail iomlán:
ContextPageMetalocaleTeaghránRiachtanachTeanga roghnaithe don iarratas seo.
market_codeTeaghránRiachtanachCód margaidh a thugann an críochphointe comhthéacs.
market_idTeaghránRiachtanachAitheantóir margaidh a thugann an críochphointe comhthéacs.
paginationPaginationRiachtanachMeiteashonraí leathanaithe le cúrsóir.
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
localeTeaghránRiachtanachTeanga roghnaithe don iarratas seo.
market_codeTeaghránRiachtanachCód margaidh a thugann an críochphointe comhthéacs.
market_idTeaghránRiachtanachAitheantóir margaidh a thugann an críochphointe comhthéacs.
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
paginationPaginationRiachtanachMeiteashonraí leathanaithe le cúrsóir.
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
Stádas HTTP
200- Freagra rathúil Scéim
400- Iarratas neamhbhailí
401- Fíordheimhniú riachtanach
403- Cead diúltaithe
404- Acmhainn gan aimsiú
409- Coinbhleacht leagain
422- Theip ar bhailíochtú
429- Teorainn iarratas sáraithe
Stádais HTTP eile (7)
405- Modh neamhcheadaithe
413- Iarratas rómhór
415- Formáid gan tacaíocht
500- Earráid freastalaí
502- Earráid gheata API
503- Seirbhís gan fáil
504- Teorainn ama sáraithe
Catalóg earráidí: ErrorResponse
Ceanntásca
401
WWW-AuthenticateTeaghránRoghnachAn scéim fíordheimhnithe a éilíonn an freastalaí.
405
AllowTeaghránRoghnachModhanna HTTP a thacaíonn an acmhainn seo leo.
429, 503
Retry-AfterSlánuimhirRoghnachAn mhoill íosta roimh atriail, i soicindí.
minimum:0