Uppdatera — CMS-sidor
Ändra angivna data i ”CMS-sidor”. Obligatoriska fält och skrivregler beskrivs nedan.
PATCH/api/v1/pages/{page_id}
- Autentisering
Bearer- Tillgänglig från
- STANDARD
- Behörigheter som krävs
content.page:update
Kodexempel
Exempel på begäran
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request PATCH \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-update_page_api_v1_pages__page_id__patch' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 1,
"title": "Example"
}' \
--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 = ['Idempotency-Key: example-update_page_api_v1_pages__page_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/pages/example');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
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);
},
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
"expected_version": 1,
"title": "Example"
}');
$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 = {'Idempotency-Key': 'example-update_page_api_v1_pages__page_id__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "expected_version": 1,\n "title": "Example"\n}'
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(
'PATCH', 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))
Exempel på svar 200
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Så fungerar det
- Skrivningar till sidor omfattar titel, slug, HTML-innehåll, SEO-metadata, publiceringsstatus och marknadsomfattning som stöds.
- Välj språket uttryckligen när du underhåller översatt innehåll.
- PATCH ändrar endast de fält som skickas.
- null tillåts bara där schemat och kontexten tillåter att värdet rensas.
- Befintliga publiceringsregler, innehållsvalidering och abonnemangsregler gäller fortfarande.
Parametrar
Sökvägsparametrar
page_idSträngObligatorisktCMS-sidans identifierare.
Begränsningar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Frågeparametrar
localeSträng nullValfrittSpråk valt för denna begäran.
Sträng:minLength:2maxLength:20market_idSträng nullValfrittMarknadsidentifierare returnerad av kontextendpointen.
Begränsningar · Sträng 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeSträng nullValfrittMarknadskod returnerad av kontextendpointen.
Sträng:minLength:1maxLength:16
Begärandehuvuden
Idempotency-KeySträngObligatorisktUnik identifierare för en logisk skrivoperation.
minLength:1maxLength:128Begränsningar
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Begärans innehåll
application/json · Obligatoriskt
PageUpdate
body_htmlSträng nullValfrittSidans innehåll i HTML.
Sträng:maxLength:100000expected_versionHeltalObligatorisktVersion läst före skrivningen; avvikelse gör att ändringen avvisas.
minimum:1maximum:2147483647market_idsArray <Sträng> ValfrittIdentifierare för valda marknader.
maxItems:1000Array:minLength:1maxLength:63market_scopeSträngValfrittAnger om resursen gäller alla eller valda marknader.
Begränsningar
enum["all", "selected"]
meta_descriptionSträng nullValfrittSökmotorbeskrivning på valt språk.
Sträng:maxLength:160meta_keywordsArray <Sträng> nullValfrittSökord för sökmotorer på valt språk.
Array:maxItems:20Array / Array:maxLength:60meta_titleSträng nullValfrittSökmotortitel på valt språk.
Sträng:maxLength:70publishedBooleskt värdeValfrittAnger om resursen är publicerad.
slugSträng nullValfrittURL-segment på valt språk.
Sträng:maxLength:160titleSträng nullValfrittTitel på valt språk.
Sträng:maxLength:300
Svar
Svar 200
Fullständig modell: ApiResponse_MutationData_
dataMutationDataObligatorisktInnehållet i ett lyckat svar.
Fält ·
dataFullständig modell:
MutationDatadeletedBooleskt värdeObligatorisktAnger om borttagningen utfördes.
idSträngObligatorisktResursens identifierare; bevara den som den returneras.
versionHeltal nullObligatorisktResursversion för samtidighetskontroll.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatorisktMetadata för svaret.
Fält ·
metaFullständig modell:
ContextPageMetalocaleSträngObligatorisktSpråk valt för denna begäran.
market_codeSträngObligatorisktMarknadskod returnerad av kontextendpointen.
market_idSträngObligatorisktMarknadsidentifierare returnerad av kontextendpointen.
paginationPaginationObligatorisktMetadata för markörbaserad paginering.
request_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
Fullständig modell:
ContextMetalocaleSträngObligatorisktSpråk valt för denna begäran.
market_codeSträngObligatorisktMarknadskod returnerad av kontextendpointen.
market_idSträngObligatorisktMarknadsidentifierare returnerad av kontextendpointen.
request_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
paginationPaginationObligatorisktMetadata för markörbaserad paginering.
request_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
Fullständig modell:
RequestMetarequest_idSträngObligatorisktÄrendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.
minLength:1maxLength:100
HTTP-status
200- Lyckat svar Schema
400- Ogiltig begäran
401- Autentisering krävs
403- Åtkomst nekad
404- Resursen hittades inte
409- Versionskonflikt
422- Valideringen misslyckades
429- Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405- Metoden tillåts inte
413- För stor begäran
415- Formatet stöds inte
500- Serverfel
502- Fel i API-gateway
503- Tjänsten är inte tillgänglig
504- Tidsgränsen överskreds
Felkatalog: ErrorResponse
HTTP-huvuden
401
WWW-AuthenticateSträngValfrittAutentiseringsschema som servern kräver.
405
AllowSträngValfrittHTTP-metoder som resursen stöder.
429, 503
Retry-AfterHeltalValfrittMinsta väntetid före ett nytt försök, i sekunder.
minimum:0