Luo — CMS-sivut
Suorita ”Luo” resurssissa ”CMS-sivut” alla kuvatuilla tiedoilla.
POST/api/v1/pages
- Todentaminen
Bearer- Saatavilla alkaen
- STANDARD
- Vaaditut käyttöoikeudet
content.page:create
Koodiesimerkit
Pyyntöesimerkki
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))
Vastausesimerkki 201
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Periaatteet
- Sivujen kirjoitukset kattavat otsikon, slug-tunnisteen, HTML-sisällön, SEO-metatiedot, julkaisutilan ja tuetun markkinakattavuuden.
- Valitse kieli nimenomaisesti käännettyä sisältöä ylläpitäessäsi.
- PATCH muuttaa vain annetut kentät.
- Null on sallittu vain silloin, kun skeema ja konteksti sallivat arvon tyhjentämisen.
- Nykyiset julkaisu-, sisällön validointi- ja pakettisäännöt pysyvät voimassa.
Parametrit
Kyselyparametrit
localeMerkkijono nullValinnainenTälle pyynnölle valittu kieli.
Merkkijono:minLength:2maxLength:20market_idMerkkijono nullValinnainenKontekstipäätepisteen palauttama markkinatunniste.
Rajoitukset · Merkkijono 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeMerkkijono nullValinnainenKontekstipäätepisteen palauttama markkinakoodi.
Merkkijono:minLength:1maxLength:16
Pyynnön otsakkeet
Idempotency-KeyMerkkijonoPakollinenYhden loogisen kirjoitustoiminnon yksilöllinen tunniste.
minLength:1maxLength:128Rajoitukset
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Pyynnön sisältö
application/json · Pakollinen
PageCreate
body_htmlMerkkijono nullValinnainenSivun HTML-sisältö.
Merkkijono:maxLength:100000market_idsTaulukko <Merkkijono> ValinnainenValittujen markkina-alueiden tunnisteet.
maxItems:1000Taulukko:minLength:1maxLength:63market_scopeMerkkijonoValinnainenKoskeeko resurssi kaikkia vai valittuja markkina-alueita.
Rajoitukset
enum["all", "selected"]
meta_descriptionMerkkijono nullValinnainenHakukonekuvaus valitulla kielellä.
Merkkijono:maxLength:160meta_keywordsTaulukko <Merkkijono> nullValinnainenHakukoneavainsanat valitulla kielellä.
Taulukko:maxItems:20Taulukko / Taulukko:maxLength:60meta_titleMerkkijono nullValinnainenHakukoneotsikko valitulla kielellä.
Merkkijono:maxLength:70publishedTotuusarvoValinnainenOnko resurssi julkaistu.
slugMerkkijono nullValinnainenURL-polun osa valitulla kielellä.
Merkkijono:maxLength:160titleMerkkijonoPakollinenOtsikko valitulla kielellä.
minLength:1maxLength:300
Vastaukset
Vastaus 201
Koko malli: ApiResponse_MutationData_
dataMutationDataPakollinenOnnistuneen vastauksen sisältö.
Kentät ·
datadeletedTotuusarvoPakollinenToteutettiinko poisto.
idMerkkijonoPakollinenResurssin tunniste; säilytä se palautetussa muodossa.
versionKokonaisluku nullPakollinenSamanaikaisuuden hallintaan käytetty resurssiversio.
metaContextPageMetaContextMetaPageMetaRequestMetaPakollinenVastauksen metatiedot.
Kentät ·
metalocaleMerkkijonoPakollinenTälle pyynnölle valittu kieli.
market_codeMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinakoodi.
market_idMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinatunniste.
paginationPaginationPakollinenKohdistinpohjaisen sivutuksen metatiedot.
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
localeMerkkijonoPakollinenTälle pyynnölle valittu kieli.
market_codeMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinakoodi.
market_idMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinatunniste.
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
paginationPaginationPakollinenKohdistinpohjaisen sivutuksen metatiedot.
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
HTTP-tilakoodi
201- Resurssi luotu Skeema
400- Virheellinen pyyntö
401- Tunnistautuminen vaaditaan
403- Pääsy estetty
404- Resurssia ei löydy
409- Versioristiriita
422- Validointi epäonnistui
429- Pyyntöraja ylitetty
Muut HTTP-tilat (7)
405- Menetelmä ei ole sallittu
413- Pyyntö on liian suuri
415- Muotoa ei tueta
500- Palvelinvirhe
502- API-yhdyskäytävän virhe
503- Palvelu ei ole käytettävissä
504- Aikakatkaisu
Virheluettelo: ErrorResponse
Otsakkeet
201
LocationMerkkijonoValinnainenLuodun resurssin suhteellinen URL-osoite.
401
WWW-AuthenticateMerkkijonoValinnainenPalvelimen vaatima todentamismenetelmä.
405
AllowMerkkijonoValinnainenTämän resurssin tukemat HTTP-metodit.
429, 503
Retry-AfterKokonaislukuValinnainenVähimmäisviive ennen uudelleenyritystä sekunteina.
minimum:0