Pređi na sadržaj
ShopentlyLearn

Kreiraj — CMS stranice

Izvršite „Kreiraj“ u „CMS stranice“ sa podacima opisanim u nastavku.

POST/api/v1/pages

Autentifikacija
Bearer
Dostupno od
STANDARD
Potrebna ovlašćenja
content.page:create

Primeri koda

Primer zahteva

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

Primer odgovora 201

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

Kako funkcioniše

  • Upisi stranica obuhvataju naslov, slug, HTML sadržaj, SEO metapodatke, stanje objave i podržani tržišni opseg.
  • Pri održavanju prevedenog sadržaja izričito odaberite jezik.
  • PATCH menja samo dostavljena polja.
  • Null je dozvoljen samo kada šema i kontekst dozvoljavaju uklanjanje vrednosti.
  • Postojeća pravila objave, provere sadržaja i plana ostaju na snazi.

Parametri

Parametri upita

localeNiz znakova nullOpciono

Jezik odabran za ovaj zahtev.

Niz znakova:minLength: 2maxLength: 20
market_idNiz znakova nullOpciono

Identifikator tržišta vraćen s krajnje tačke konteksta.

Ograničenja · Niz znakova 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeNiz znakova nullOpciono

Kod tržišta vraćen s krajnje tačke konteksta.

Niz znakova:minLength: 1maxLength: 16

Zaglavlja zahteva

Idempotency-KeyNiz znakovaObavezno

Jedinstveni identifikator jedne logičke operacije upisa.

minLength: 1maxLength: 128
Ograničenja
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Primer: "example-create_page_api_v1_pages_post"

Telo zahteva

application/json · Obavezno

PageCreate
body_htmlNiz znakova nullOpciono

Sadržaj stranice u HTML-u.

Niz znakova:maxLength: 100000
market_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori odabranih tržišta.

maxItems: 1000
Niz vrednosti:minLength: 1maxLength: 63
market_scopeNiz znakovaOpciono

Da li se odnosi resurs na sva ili na odabrana tržišta.

Ograničenja
enum
["all", "selected"]
meta_descriptionNiz znakova nullOpciono

Opis za pretraživače na odabranom jeziku.

Niz znakova:maxLength: 160
meta_keywordsNiz vrednosti <Niz znakova> nullOpciono

Ključne reči za pretraživače na odabranom jeziku.

Niz vrednosti:maxItems: 20
Niz vrednosti / Niz vrednosti:maxLength: 60
meta_titleNiz znakova nullOpciono

Naslov za pretraživače na odabranom jeziku.

Niz znakova:maxLength: 70
publishedLogička vrednostOpciono

Da li je resurs objavljen.

Podrazumevano: false
slugNiz znakova nullOpciono

Deo URL putanje na odabranom jeziku.

Niz znakova:maxLength: 160
titleNiz znakovaObavezno

Naslov na odabranom jeziku.

minLength: 1maxLength: 300
Primer: "Example"

Odgovori

Odgovor 201

dataMutationData Obavezno

Podaci uspešnog odgovora.

Polja · data
deletedLogička vrednostObavezno

Da li je brisanje primenjeno.

idNiz znakovaObavezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

versionCeli broj nullObavezno

Verzija resursa za kontrolu istovremenih upisa.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno

Metapodaci odgovora.

Polja · meta

ContextPageMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

ContextMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

RequestMeta

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer odgovora

HTTP status

201
Resurs kreiran Šema
400
Nevažeći zahtev
401
Potrebna je autentifikacija
403
Pristup odbijen
404
Resurs nije pronađen
409
Sukob verzija
422
Provera nije uspela
429
Prekoračeno ograničenje zahteva
Ostali HTTP statusi (7)
405
Metoda nije dozvoljena
413
Zahtev je prevelik
415
Nepodržan format
500
Greška servera
502
Greška API mrežnog prolaza
503
Usluga nije dostupna
504
Istek vremena

Katalog grešaka: ErrorResponse

Zaglavlja

201

LocationNiz znakovaOpciono

Relativni URL kreiranog resursa.

401

WWW-AuthenticateNiz znakovaOpciono

Šema autentifikacije koju zahteva server.

405

AllowNiz znakovaOpciono

HTTP metode koje ovaj resurs podržava.

429, 503

Retry-AfterCeli brojOpciono

Najkraće čekanje pre ponavljanja, u sekundama.

minimum: 0