Gå til indhold
ShopentlyLearn

Opret — CMS-sider

Udfør ”Opret” i ”CMS-sider” med de data, der er beskrevet nedenfor.

POST/api/v1/pages

Godkendelse
Bearer
Tilgængelig fra
STANDARD
Nødvendige rettigheder
content.page:create

Kodeeksempler

Eksempel på forespørgsel

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

Eksempel på svar 201

JSON
{
  "data": {
    "deleted": false,
    "id": "example",
    "version": 1
  },
  "meta": {
    "request_id": "example"
  }
}

Principper

  • Skriveoperationer på sider omfatter titel, slug, HTML-indhold, SEO-metadata, publiceringstilstand og understøttet markedsomfang.
  • Vælg sproget eksplicit, når du vedligeholder oversat indhold.
  • PATCH ændrer kun angivne felter.
  • Null er kun tilladt, hvor skema og kontekst tillader at rydde en værdi.
  • Eksisterende regler for publicering, indholdsvalidering og abonnementer gælder fortsat.

Parametre

Forespørgselsparametre

localeStreng nullValgfrit

Sprog valgt til denne forespørgsel.

Streng:minLength: 2maxLength: 20
market_idStreng nullValgfrit

Markedsidentifikator returneret af kontekstendepunktet.

Begrænsninger · Streng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStreng nullValgfrit

Markedskode returneret af kontekstendepunktet.

Streng:minLength: 1maxLength: 16

Anmodningsheadere

Idempotency-KeyStrengObligatorisk

Unik identifikator for én logisk skriveoperation.

minLength: 1maxLength: 128
Begrænsninger
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Eksempel: "example-create_page_api_v1_pages_post"

Forespørgselsindhold

application/json · Obligatorisk

PageCreate
body_htmlStreng nullValgfrit

Sidens indhold i HTML.

Streng:maxLength: 100000
market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeStrengValgfrit

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger
enum
["all", "selected"]
meta_descriptionStreng nullValgfrit

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleStreng nullValgfrit

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

Standard: false
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
titleStrengObligatorisk

Titel på det valgte sprog.

minLength: 1maxLength: 300
Eksempel: "Example"

Svar

Svar 201

dataMutationData Obligatorisk

Indholdet af et vellykket svar.

Felter · data
deletedBoolesk værdiObligatorisk

Om sletningen blev udført.

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

versionHeltal nullObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

ContextMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

RequestMeta

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

201
Ressource oprettet Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

201

LocationStrengValgfrit

Relativ URL til den oprettede ressource.

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0