Preskoči na vsebino
ShopentlyLearn

Ustvari — Strani CMS

Izvedite »Ustvari« v »Strani CMS« s spodaj opisanimi podatki.

POST/api/v1/pages

Preverjanje pristnosti
Bearer
Na voljo od paketa
STANDARD
Zahtevana dovoljenja
content.page:create

Primeri kode

Primer zahteve

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 deluje

  • Zapisi strani zajemajo naslov, del poti URL, vsebino HTML, metapodatke SEO, stanje objave in podprti obseg trgov.
  • Pri vzdrževanju prevodov izrecno izberite jezik.
  • PATCH spremeni samo posredovana polja.
  • Null je dovoljen samo tam, kjer shema in kontekst dopuščata izbris vrednosti.
  • Še vedno veljajo obstoječa pravila objave, preverjanja vsebine in paketa.

Parametri

Parametri poizvedbe

localeNiz nullIzbirno

Jezik, izbran za to zahtevo.

Niz:minLength: 2maxLength: 20
market_idNiz nullIzbirno

Identifikator trga, vrnjen s končno točko konteksta.

Omejitve · Niz 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeNiz nullIzbirno

Koda trga, vrnjena s končno točko konteksta.

Niz:minLength: 1maxLength: 16

Glave zahteve

Idempotency-KeyNizObvezno

Enolični identifikator ene logične operacije zapisa.

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

Telo zahteve

application/json · Obvezno

PageCreate
body_htmlNiz nullIzbirno

Vsebina strani v HTML.

Niz:maxLength: 100000
market_idsPolje elementov <Niz> Izbirno

Identifikatorji izbranih trgov.

maxItems: 1000
Polje elementov:minLength: 1maxLength: 63
market_scopeNizIzbirno

Ali vir velja za vse ali izbrane trge.

Omejitve
enum
["all", "selected"]
meta_descriptionNiz nullIzbirno

Opis za iskalnike v izbranem jeziku.

Niz:maxLength: 160
meta_keywordsPolje elementov <Niz> nullIzbirno

Ključne besede za iskalnike v izbranem jeziku.

Polje elementov:maxItems: 20
Polje elementov / Polje elementov:maxLength: 60
meta_titleNiz nullIzbirno

Naslov za iskalnike v izbranem jeziku.

Niz:maxLength: 70
publishedLogična vrednostIzbirno

Ali je vir objavljen.

Privzeto: false
slugNiz nullIzbirno

Del poti URL v izbranem jeziku.

Niz:maxLength: 160
titleNizObvezno

Naslov v izbranem jeziku.

minLength: 1maxLength: 300
Primer: "Example"

Odgovori

Odgovor 201

dataMutationData Obvezno

Vsebina uspešnega odgovora.

Polja · data
deletedLogična vrednostObvezno

Ali je bilo brisanje izvedeno.

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

versionCelo število nullObvezno

Različica vira za nadzor sočasnosti.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodatki odgovora.

Polja · meta

ContextPageMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

ContextMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100
Primer odgovora

Status HTTP

201
Vir ustvarjen Shema
400
Neveljavna zahteva
401
Potrebna je avtentikacija
403
Dostop zavrnjen
404
Vir ni najden
409
Spor različic
422
Preverjanje ni uspelo
429
Presežena omejitev zahtev
Druga stanja HTTP (7)
405
Metoda ni dovoljena
413
Zahteva je prevelika
415
Nepodprta oblika
500
Napaka strežnika
502
Napaka prehoda API
503
Storitev ni na voljo
504
Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

201

LocationNizIzbirno

Relativni URL ustvarjenega vira.

401

WWW-AuthenticateNizIzbirno

Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno

Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno

Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0