Yeni yorum
Editoryal yorumlar oluşturma
POST/api/v1/addons/shopently.blog/comments
- 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:comment_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: learn-e53442b24a8748e79c202f8ad4c82b9e' \
--header 'Content-Type: application/json' \
--data-raw '{
"body": "Zapraszamy do zadawania pytań.",
"display_name": "Redakcja",
"locale": "pl",
"post_id": "2103ba96-2713-420b-b197-8a008730c851"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/comments
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-e53442b24a8748e79c202f8ad4c82b9e', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/comments');
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, '{
"body": "Zapraszamy do zadawania pytań.",
"display_name": "Redakcja",
"locale": "pl",
"post_id": "2103ba96-2713-420b-b197-8a008730c851"
}');
$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-e53442b24a8748e79c202f8ad4c82b9e'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "body": "Zapraszamy do zadawania pytań.",\n "display_name": "Redakcja",\n "locale": "pl",\n "post_id": "2103ba96-2713-420b-b197-8a008730c851"\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/addons/shopently.blog/comments', 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
{
"data": {
"id": "2247b58d-1521-4fc0-9eec-6c47c259c181",
"status": "approved",
"version": 1
},
"meta": {
"request_id": "75ae817c-2925-48e0-ab57-1216a6e4ed45"
}
}
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:comment_create
Parametreler
İ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
bodyDizeZorunluYorum
minLength:1maxLength:5000display_nameDizeZorunluAd
minLength:1maxLength:160expected_versionTam sayıİsteğe bağlıYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
const:1localeDizeZorunluBu istek için seçilen dil.
minLength:2maxLength:35Kısıtlamalar
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
post_idDizeZorunluMakale
format:"uuid"
Yanıtlar
Yanıt 201
dataNesneEk alanlar: HayırZorunluBaşarılı yanıtın verileri.
Alanlar ·
dataidDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
format:"uuid"statusDizeZorunluBu işlemin kabul ettiği durum.
Kısıtlamalar
enum["pending", "approved", "rejected", "spam"]
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
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
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