Przejdź do treści
ShopentlyLearn

Utwórz stronę CMS

Utwórz stronę CMS przez Shopently API. Sprawdź wymagane pola JSON, uprawnienia i zasady zapisu. Przykłady cURL, PHP i Python.

POST/api/v1/pages

Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
content.page:create

Przykłady kodu

Przykład żądania

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

Przykład odpowiedzi 201

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

Jak to działa

  • Zapisy stron obejmują tytuł, slug, treść HTML, metadane SEO, stan publikacji i obsługiwany zakres rynków.
  • Przy zarządzaniu tłumaczeniami jawnie wybieraj język.
  • PATCH zmienia tylko przesłane pola.
  • Null jest dozwolony wyłącznie tam, gdzie schemat i kontekst pozwalają usunąć wartość.
  • Nadal obowiązują reguły publikacji, walidacji treści i planu.

Parametry

Parametry zapytania

localeTekst nullOpcjonalne

Język wybrany dla tego żądania.

Tekst:minLength: 2maxLength: 20
market_idTekst nullOpcjonalne

Identyfikator rynku zwrócony przez endpoint kontekstu.

Ograniczenia · Tekst 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeTekst nullOpcjonalne

Kod rynku zwrócony przez endpoint kontekstu.

Tekst:minLength: 1maxLength: 16

Nagłówki żądania

Idempotency-KeyTekstWymagane

Unikalny identyfikator jednej logicznej operacji zapisu.

minLength: 1maxLength: 128
Ograniczenia
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Przykład: "example-create_page_api_v1_pages_post"

Treść żądania

application/json · Wymagane

PageCreate
body_htmlTekst nullOpcjonalne

Treść strony w HTML.

Tekst:maxLength: 100000
market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
market_scopeTekstOpcjonalne

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia
enum
["all", "selected"]
meta_descriptionTekst nullOpcjonalne

Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160
meta_keywordsTablica <Tekst> nullOpcjonalne

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20
Tablica / Tablica:maxLength: 60
meta_titleTekst nullOpcjonalne

Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70
publishedWartość logicznaOpcjonalne

Czy zasób jest opublikowany.

Wartość domyślna: false
slugTekst nullOpcjonalne

Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160
titleTekstWymagane

Tytuł w wybranym języku.

minLength: 1maxLength: 300
Przykład: "Example"

Odpowiedzi

Odpowiedź 201

dataMutationData Wymagane

Dane poprawnej odpowiedzi.

Pola · data
deletedWartość logicznaWymagane

Czy zastosowano usunięcie.

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

versionLiczba całkowita nullWymagane

Wersja zasobu używana do kontroli współbieżności.

metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Pola · meta

ContextPageMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

201
Utworzono zasób Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

201

LocationTekstOpcjonalne

Względny adres utworzonego zasobu.

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0