Sąrašas · Komentarai
Skaityti komentarus ir moderavimo būseną
GET/api/v1/addons/shopently.blog/comments
- Tapatybės patvirtinimas
Bearer- Prieinama nuo plano
- BASIC
- Būtinas įdiegtas modulis
shopently.blog· Modulio sutarties versija 1- Būtinos teisės
addon.shopently.blog:comment_read
Kodo pavyzdžiai
Užklausos pavyzdys
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/addons/shopently.blog/comments?limit=10&post_id=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 = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/comments?limit=10&post_id=2103ba96-2713-420b-b197-8a008730c851');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
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);
},
]);
$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 = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
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(
'GET', base_url + '/api/v1/addons/shopently.blog/comments?limit=10&post_id=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))
Atsakymo pavyzdys 200
{
"data": [
{
"actor_kind": "api",
"body_preview": "Zapraszamy do zadawania pytań.",
"created_at": "2026-10-07T23:17:44.892022Z",
"display_name": "Redakcja",
"edited_at": null,
"id": "2247b58d-1521-4fc0-9eec-6c47c259c181",
"locale": "pl",
"post_id": "2103ba96-2713-420b-b197-8a008730c851",
"status": "approved",
"version": 1
}
],
"meta": {
"pagination": {
"has_more": false,
"limit": 10,
"next_cursor": null
},
"request_id": "a27f02dc-4061-4716-9766-a1eec23ac186"
}
}
Apžvalga
Tvarkykite parduotuvės tinklaraštį su HTML straipsniais, nuotraukomis, autoriais ir paieškos sistemų metaduomenimis. Saugokite juodraščius, ruoškite vertimus ir publikuokite iš karto arba pasirinktu laiku konkrečioje laiko juostoje. Valdykite komentarus ir moderavimą skydelyje; išorinis generatorius gali naudoti API su suteiktomis teisėmis.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:comment_read
Parametrai
Užklausos parametrai
limitSveikasis skaičiusNeprivalomasDidžiausias įrašų skaičius šiame puslapyje.
minimum:1maximum:100cursorEilutė nullNeprivalomasAnkstesnio puslapio grąžinta tęsimo reikšmė; jos vidinės struktūros neinterpretuokite.
Eilutė:maxLength:512post_idEilutė nullNeprivalomasStraipsnis
Eilutė:format:"uuid"statusEilutė nullNeprivalomasŠios konkrečios operacijos priimama būsena.
Apribojimai · Eilutė 1
enum["pending", "approved", "rejected", "spam"]
Ši operacija nepriima JSON turinio.
Atsakymai
Atsakymas 200
dataMasyvas <ObjektasPapildomi laukai: Ne> PrivalomasSėkmingo atsakymo duomenys.
maxItems:100Laukai ·
dataObjektasPapildomi laukai: Ne
actor_kindEilutėPrivalomasVeikėjo tipas
Apribojimai
enum["administrator", "customer", "api"]
body_previewEilutėPrivalomasKomentaras
minLength:1maxLength:250created_atEilutėPrivalomasSukūrimo laikas.
format:"date-time"display_nameEilutėPrivalomasVardas
minLength:1maxLength:160edited_atEilutė nullPrivalomasRedaguota
Eilutė:format:"date-time"idEilutėPrivalomasIštekliaus identifikatorius; išsaugokite grąžintą išraišką.
format:"uuid"localeEilutėPrivalomasŠiai užklausai pasirinkta kalba.
minLength:2maxLength:35Apribojimai
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
post_idEilutėPrivalomasStraipsnis
format:"uuid"statusEilutėPrivalomasŠios konkrečios operacijos priimama būsena.
Apribojimai
enum["pending", "approved", "rejected", "spam"]
versionSveikasis skaičiusPrivalomasIštekliaus versija lygiagrečių pakeitimų kontrolei.
minimum:1maximum:9223372036854775807
metaObjektasPapildomi laukai: NePrivalomasAtsakymo metaduomenys.
Laukai ·
metapaginationObjektasPapildomi laukai: NePrivalomasSkaidymo į puslapius pagal žymeklį metaduomenys.
Laukai ·
paginationhas_moreLoginė reikšmėPrivalomasAr yra kitas puslapis.
limitSveikasis skaičiusPrivalomasDidžiausias įrašų skaičius šiame puslapyje.
minimum:1maximum:100next_cursorEilutė nullPrivalomasKito puslapio tęsimo reikšmė arba null.
Eilutė:maxLength:512
request_idEilutėPrivalomasPrašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength:1maxLength:100
HTTP būsena
200- Sėkmingas atsakymas Schema
400- Netinkama užklausa
401- Būtinas tapatybės patvirtinimas
403- Prieiga uždrausta
404- Išteklius nerastas
409- Versijų konfliktas
422- Tikrinimo klaida
429- Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405- Metodas neleidžiamas
413- Užklausa per didelė
415- Nepalaikomas formatas
500- Serverio klaida
502- API tinklų sietuvo klaida
503- Paslauga nepasiekiama
504- Baigėsi laukimo laikas
Klaidų katalogas: ErrorResponse
Antraštės
401
WWW-AuthenticateEilutėNeprivalomasServerio reikalaujama tapatybės patvirtinimo schema.
405
AllowEilutėNeprivalomasŠio ištekliaus palaikomi HTTP metodai.
429, 503
Retry-AfterSveikasis skaičiusNeprivalomasMažiausias laukimo laikas prieš kartojant, sekundėmis.
minimum:0