İçeriğe atla
ShopentlyLearn

Oluştur — CMS sayfaları

Aşağıda açıklanan verilerle “CMS sayfaları” içinde “Oluştur” işlemini gerçekleştirin.

POST/api/v1/pages

Kimlik doğrulama
Bearer
En düşük plan
STANDARD
Gerekli izinler
content.page:create

Kod örnekleri

İstek örneği

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

Yanıt örneği 201

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

Nasıl çalışır

  • Sayfa yazma işlemleri başlık, slug, HTML içeriği, SEO meta verileri, yayımlanma durumu ve desteklenen pazar kapsamını içerir.
  • Çevrilmiş içeriği yönetirken dili açıkça seçin.
  • PATCH yalnızca gönderilen alanları değiştirir.
  • Null değerine yalnızca şema ve bağlam bir değerin temizlenmesine izin verdiğinde izin verilir.
  • Mevcut yayımlama, içerik doğrulama ve plan kuralları geçerliliğini korur.

Parametreler

Sorgu parametreleri

localeDize nullİsteğe bağlı

Bu istek için seçilen dil.

Dize:minLength: 2maxLength: 20
market_idDize nullİsteğe bağlı

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Kısıtlamalar · Dize 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeDize nullİsteğe bağlı

Bağlam uç noktasının döndürdüğü pazar kodu.

Dize:minLength: 1maxLength: 16

İstek başlıkları

Idempotency-KeyDizeZorunlu

Tek bir mantıksal yazma işleminin benzersiz tanımlayıcısı.

minLength: 1maxLength: 128
Kısıtlamalar
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Örnek: "example-create_page_api_v1_pages_post"

İstek gövdesi

application/json · Zorunlu

PageCreate
body_htmlDize nullİsteğe bağlı

HTML biçiminde sayfa içeriği.

Dize:maxLength: 100000
market_idsDizi <Dize> İsteğe bağlı

Seçilen pazarların tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
market_scopeDizeİsteğe bağlı

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar
enum
["all", "selected"]
meta_descriptionDize nullİsteğe bağlı

Seçilen dilde arama motoru açıklaması.

Dize:maxLength: 160
meta_keywordsDizi <Dize> nullİsteğe bağlı

Seçilen dilde arama motoru anahtar kelimeleri.

Dizi:maxItems: 20
Dizi / Dizi:maxLength: 60
meta_titleDize nullİsteğe bağlı

Seçilen dilde arama motoru başlığı.

Dize:maxLength: 70
publishedMantıksal değerİsteğe bağlı

Kaynağın yayımlanıp yayımlanmadığı.

Varsayılan: false
slugDize nullİsteğe bağlı

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160
titleDizeZorunlu

Seçilen dilde başlık.

minLength: 1maxLength: 300
Örnek: "Example"

Yanıtlar

Yanıt 201

dataMutationData Zorunlu

Başarılı yanıtın verileri.

Alanlar · data
deletedMantıksal değerZorunlu

Silme işleminin uygulanıp uygulanmadığı.

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.

versionTam sayı nullZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Alanlar · meta

ContextPageMeta

localeDizeZorunlu

Bu istek için seçilen dil.

market_codeDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar kodu.

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

ContextMeta

localeDizeZorunlu

Bu istek için seçilen dil.

market_codeDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar kodu.

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

PageMeta

paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

RequestMeta

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100
Yanıt örneği

HTTP durumu

201
Kaynak oluşturuldu Şema
400
Geçersiz istek
401
Kimlik doğrulaması gerekli
403
İzin reddedildi
404
Kaynak bulunamadı
409
Sürüm çakışması
422
Doğrulama başarısız
429
İstek sınırı aşıldı
Diğer HTTP durumları (7)
405
Yönteme izin verilmiyor
413
İstek çok büyük
415
Desteklenmeyen biçim
500
Sunucu hatası
502
API ağ geçidi hatası
503
Hizmet kullanılamıyor
504
Zaman aşımı

Hata kataloğu: ErrorResponse

Başlıklar

201

LocationDizeİsteğe bağlı

Oluşturulan kaynağın göreli URL'si.

401

WWW-AuthenticateDizeİsteğe bağlı

Sunucunun gerektirdiği kimlik doğrulama şeması.

405

AllowDizeİsteğe bağlı

Bu kaynağın desteklediği HTTP yöntemleri.

429, 503

Retry-AfterTam sayıİsteğe bağlı

Yeniden denemeden önce saniye cinsinden en kısa bekleme süresi.

minimum: 0