Vytvoriť — Stránky CMS
Vykonajte „Vytvoriť“ v „Stránky CMS“ s údajmi opísanými nižšie.
POST/api/v1/pages
- Overovanie
Bearer- Dostupné od plánu
- STANDARD
- Požadované oprávnenia
content.page:create
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 POST \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-create_page_api_v1_pages_post' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/pages
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-create_page_api_v1_pages_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/pages');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'POST',
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, '{
"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-create_page_api_v1_pages_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\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(
'POST', base_url + '/api/v1/pages', 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 201
{
"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 dopytu
localeReťazec nullVoliteľnéJazyk vybraný pre túto požiadavku.
Reťazec:minLength:2maxLength:20market_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:128Obmedzenia
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Telo požiadavky
application/json · Povinné
PageCreate
body_htmlReťazec nullVoliteľnéObsah stránky vo formáte HTML.
Reťazec:maxLength:100000market_idsPole <Reťazec> VoliteľnéIdentifikátory vybraných trhov.
maxItems:1000Pole:minLength:1maxLength:63market_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:160meta_keywordsPole <Reťazec> nullVoliteľnéKľúčové slová pre vyhľadávače vo vybranom jazyku.
Pole:maxItems:20Pole / Pole:maxLength:60meta_titleReťazec nullVoliteľnéTitulok pre vyhľadávače vo vybranom jazyku.
Reťazec:maxLength:70publishedLogická hodnotaVoliteľnéČi je zdroj zverejnený.
slugReťazec nullVoliteľnéÚsek cesty URL vo vybranom jazyku.
Reťazec:maxLength:160titleReťazecPovinnéNázov vo vybranom jazyku.
minLength:1maxLength:300
Odpovede
Odpoveď 201
Úplný model: ApiResponse_MutationData_
dataMutationDataPovinnéObsah úspešnej odpovede.
Polia ·
datadeletedLogická 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.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Polia ·
metalocaleReť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.
paginationPaginationPovinné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
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
paginationPaginationPovinné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
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
Stav HTTP
201- Zdroj vytvorený 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
201
LocationReťazecVoliteľnéRelatívna URL vytvoreného zdroja.
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