Preskočiť na obsah
ShopentlyLearn

Upraviť — Stránky CMS

Zmeňte zadané údaje v „Stránky CMS“. Povinné polia a pravidlá zápisu sú opísané nižšie.

PATCH/api/v1/pages/{page_id}

Overovanie
Bearer
Dostupné od plánu
STANDARD
Požadované oprávnenia
content.page:update

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 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))

Príklad odpovede 200

JSON
{
  "data": {
    "deleted": false,
    "id": "example",
    "version": 1
  },
  "meta": {
    "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}$"
Príklad: "example"

Parametre dopytu

localeReťazec nullVoliteľné

Jazyk vybraný pre túto požiadavku.

Reťazec:minLength: 2maxLength: 20
market_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

Hlavičky požiadavky

Idempotency-KeyReťazecPovinné

Jedinečný identifikátor jednej logickej operácie zápisu.

minLength: 1maxLength: 128
Obmedzenia
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Príklad: "example-update_page_api_v1_pages__page_id__patch"

Telo požiadavky

application/json · Povinné

PageUpdate
body_htmlReťazec nullVoliteľné

Obsah stránky vo formáte HTML.

Reťazec:maxLength: 100000
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 2147483647
Príklad: 1
market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000
Pole:minLength: 1maxLength: 63
market_scopeReťazecVoliteľné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia
enum
["all", "selected"]
meta_descriptionReťazec nullVoliteľné

Opis pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 160
meta_keywordsPole <Reťazec> nullVoliteľné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Pole:maxItems: 20
Pole / Pole:maxLength: 60
meta_titleReťazec nullVoliteľné

Titulok pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 70
publishedLogická hodnotaVoliteľné

Či je zdroj zverejnený.

slugReťazec nullVoliteľné

Úsek cesty URL vo vybranom jazyku.

Reťazec:maxLength: 160
titleReťazec nullVoliteľné

Názov vo vybranom jazyku.

Reťazec:maxLength: 300
Príklad: "Example"

Odpovede

Odpoveď 200

dataMutationData Povinné

Obsah úspešnej odpovede.

Polia · data
deletedLogická hodnotaPovinné

Či bolo zmazanie vykonané.

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

versionCelé číslo nullPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metaúdaje odpovede.

Polia · meta

ContextPageMeta

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.

paginationPagination Povinné

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

ContextMeta

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

PageMeta

paginationPagination Povinné

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

RequestMeta

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100
Príklad odpovede

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