Přejít na obsah
ShopentlyLearn

Upravit článek

Upravovat koncepty článků a překlady

PATCH/api/v1/addons/shopently.blog/posts/{post_id}

Ověřování
Bearer
Dostupné od tarifu
BASIC
Vyžadovaný nainstalovaný modul
shopently.blog · Verze kontraktu modulu 1
Požadovaná oprávnění
addon.shopently.blog:post_update

Příklady kódu

Příklad požadavku

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request PATCH \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: learn-6486f38921214552949f30311a1f543f' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.",
  "expected_version": 1,
  "locale": "pl"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851

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: learn-6486f38921214552949f30311a1f543f', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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, '{
  "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.",
  "expected_version": 1,
  "locale": "pl"
}');
$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': 'learn-6486f38921214552949f30311a1f543f'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.",\n  "expected_version": 1,\n  "locale": "pl"\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(
        'PATCH', base_url + '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851', 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))

Příklad odpovědi 200

JSON
{
  "data": {
    "html_normalized": false,
    "id": "2103ba96-2713-420b-b197-8a008730c851",
    "public_number": null,
    "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40",
    "status": "draft",
    "version": 2
  },
  "meta": {
    "request_id": "bd4bb9ba-0f29-41c0-858d-3581bb03928f"
  }
}

Přehled

Veďte blog obchodu s články v HTML, fotografiemi, autory a metadaty pro vyhledávače. Ukládejte koncepty, připravujte překlady a publikujte ihned nebo ve zvolený čas a časové pásmo. Komentáře a moderaci spravujte v panelu; externí generátor může využít API s přidělenými oprávněními.

BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:post_update

Parametry

Parametry cesty

post_idŘetězecPovinné

Článek

format: "uuid"
Příklad: "2103ba96-2713-420b-b197-8a008730c851"

Hlavičky požadavku

Idempotency-KeyŘetězecPovinné

Jedinečný identifikátor jedné logické operace zápisu.

minLength: 1maxLength: 128
Omezení
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Příklad: "learn-6486f38921214552949f30311a1f543f"

Tělo požadavku

application/json · Povinné

ObjektDalší pole: Ne
author_idŘetězec nullVolitelné

Autor

Řetězec:format: "uuid"
comments_modeŘetězecVolitelné

Komentáře

Omezení
enum
["inherit", "open", "closed"]
content_htmlŘetězecVolitelné

Obsah

maxLength: 50000
cover_altŘetězecVolitelné

Alternativní text

maxLength: 250
cover_captionŘetězecVolitelné

Popisek fotografie

maxLength: 500
cover_media_idŘetězec nullVolitelné

Úvodní fotografie

Řetězec:format: "uuid"
excerptŘetězecVolitelné

Úvod

maxLength: 1000
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807
localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

minLength: 2maxLength: 35
Omezení
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionŘetězecVolitelné

Popis pro vyhledávače ve vybraném jazyce.

maxLength: 160
meta_keywordsPole <Řetězec> Volitelné

Klíčová slova pro vyhledávače ve vybraném jazyce.

maxItems: 20
Pole:minLength: 1maxLength: 50
meta_titleŘetězecVolitelné

Titulek pro vyhledávače ve vybraném jazyce.

maxLength: 70
slugŘetězecVolitelné

Úsek cesty URL ve vybraném jazyce.

maxLength: 160
titleŘetězecVolitelné

Název ve vybraném jazyce.

maxLength: 200

Odpovědi

Odpověď 200

dataObjektDalší pole: NePovinné

Obsah úspěšné odpovědi.

Pole · data
html_normalizedLogická hodnotaPovinné

HTML · category-v1

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

format: "uuid"
public_numberCelé číslo nullVolitelné

Číslo

Celé číslo:minimum: 1
revision_idŘetězecPovinné

Revize

format: "uuid"
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["draft", "scheduled", "published", "archived"]
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

minimum: 1maximum: 9223372036854775807
metaObjektDalší pole: NePovinné

Metadata odpovědi.

Pole · meta
request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0