Makaleyi düzenle
Makale taslaklarını ve çevirileri düzenleme
PATCH/api/v1/addons/shopently.blog/posts/{post_id}
- Kimlik doğrulama
Bearer- En düşük plan
- BASIC
- Gerekli kurulu modül
shopently.blog· Modül sözleşme sürümü 1- Gerekli izinler
addon.shopently.blog:post_update
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 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))
Yanıt örneği 200
{
"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"
}
}
Genel bakış
Mağazanızın blogunu HTML makaleler, fotoğraflar, yazarlar ve arama motoru meta verileriyle yönetin. Taslakları kaydedin, çevirileri hazırlayın ve hemen ya da belirli bir saat diliminde seçtiğiniz zamanda yayımlayın. Yorumları ve denetimi panelden yönetin; harici bir üretici, verdiğiniz izinlerle API’yi kullanabilir.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:post_update
Parametreler
Yol parametreleri
post_idDizeZorunluMakale
format:"uuid"
İstek başlıkları
Idempotency-KeyDizeZorunluTek bir mantıksal yazma işleminin benzersiz tanımlayıcısı.
minLength:1maxLength:128Kısıtlamalar
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
İstek gövdesi
application/json · Zorunlu
author_idDize nullİsteğe bağlıYazar
Dize:format:"uuid"comments_modeDizeİsteğe bağlıYorumlar
Kısıtlamalar
enum["inherit", "open", "closed"]
content_htmlDizeİsteğe bağlıİçerik
maxLength:50000cover_altDizeİsteğe bağlıAlternatif metin
maxLength:250cover_captionDizeİsteğe bağlıFotoğraf açıklaması
maxLength:500cover_media_idDize nullİsteğe bağlıKapak fotoğrafı
Dize:format:"uuid"excerptDizeİsteğe bağlıGiriş
maxLength:1000expected_versionTam sayıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807localeDizeZorunluBu istek için seçilen dil.
minLength:2maxLength:35Kısıtlamalar
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionDizeİsteğe bağlıSeçilen dilde arama motoru açıklaması.
maxLength:160meta_keywordsDizi <Dize> İsteğe bağlıSeçilen dilde arama motoru anahtar kelimeleri.
maxItems:20Dizi:minLength:1maxLength:50meta_titleDizeİsteğe bağlıSeçilen dilde arama motoru başlığı.
maxLength:70slugDizeİsteğe bağlıSeçilen dilde URL yolu parçası.
maxLength:160titleDizeİsteğe bağlıSeçilen dilde başlık.
maxLength:200
Yanıtlar
Yanıt 200
dataNesneEk alanlar: HayırZorunluBaşarılı yanıtın verileri.
Alanlar ·
datahtml_normalizedMantıksal değerZorunluHTML · category-v1
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
format:"uuid"public_numberTam sayı nullİsteğe bağlıNumara
Tam sayı:minimum:1revision_idDizeZorunluSürüm
format:"uuid"statusDizeZorunluBu işlemin kabul ettiği durum.
Kısıtlamalar
enum["draft", "scheduled", "published", "archived"]
versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
minimum:1maximum:9223372036854775807
metaNesneEk alanlar: HayırZorunluYanıt üst verileri.
Alanlar ·
metarequest_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
HTTP durumu
200- Başarılı yanıt Ş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
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