Commento
Leggere commenti e stato di moderazione
GET/api/v1/addons/shopently.blog/comments/{comment_id}
- Autenticazione
Bearer- Disponibile dal piano
- BASIC
- Modulo installato richiesto
shopently.blog· Versione del contratto del modulo 1- Permessi necessari
addon.shopently.blog:comment_read
Esempi di codice
Esempio di richiesta
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/2247b58d-1521-4fc0-9eec-6c47c259c181
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/2247b58d-1521-4fc0-9eec-6c47c259c181');
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/2247b58d-1521-4fc0-9eec-6c47c259c181', 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))
Esempio di risposta 200
{
"data": {
"actor_id": "api_key_7da1addab52348fcbf1284d01a152ebb",
"actor_kind": "api",
"body": "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",
"moderation_reason": null,
"post_id": "2103ba96-2713-420b-b197-8a008730c851",
"status": "approved",
"updated_at": "2026-10-07T23:17:44.892022Z",
"version": 1
},
"meta": {
"request_id": "c29e8186-8b51-4f6a-9479-f6a0be76cc23"
}
}
Panoramica
Gestisci il blog del negozio con articoli HTML, foto, autori e metadati per i motori di ricerca. Salva bozze, prepara traduzioni e pubblica subito o a un orario scelto in un fuso orario specifico. Gestisci commenti e moderazione nel pannello; un generatore esterno può utilizzare l’API con i permessi concessi.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:comment_read
Parametri
Parametri del percorso
comment_idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito.
format:"uuid"
Questa operazione non accetta un corpo JSON.
Risposte
Risposta 200
dataOggettoCampi aggiuntivi: NoObbligatorioContenuto di una risposta riuscita.
Campi ·
dataactor_idStringaObbligatorioIdentificativo dell’attore
minLength:1maxLength:63actor_kindStringaObbligatorioTipo di attore
Vincoli
enum["administrator", "customer", "api"]
bodyStringaObbligatorioCommento
minLength:1maxLength:5000created_atStringaObbligatorioData e ora di creazione.
format:"date-time"display_nameStringaObbligatorioNome
minLength:1maxLength:160edited_atStringa nullObbligatorioModificato
Stringa:format:"date-time"idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito.
format:"uuid"localeStringaObbligatorioLingua selezionata per questa richiesta.
minLength:2maxLength:35Vincoli
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
moderation_reasonStringa nullObbligatorioMotivo della moderazione
Stringa:maxLength:500post_idStringaObbligatorioArticolo
format:"uuid"statusStringaObbligatorioStato accettato da questa specifica operazione.
Vincoli
enum["pending", "approved", "rejected", "spam"]
updated_atStringaObbligatorioData e ora dell’aggiornamento più recente.
format:"date-time"versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
minimum:1maximum:9223372036854775807
metaOggettoCampi aggiuntivi: NoObbligatorioMetadati della risposta.
Campi ·
metarequest_idStringaObbligatorioIdentificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.
minLength:1maxLength:100
Stato HTTP
200- Risposta riuscita Schema
400- Richiesta non valida
401- Autenticazione richiesta
403- Permesso negato
404- Risorsa non trovata
409- Conflitto di versione
422- Validazione non riuscita
429- Limite di richieste superato
Altri stati HTTP (7)
405- Metodo non consentito
413- Richiesta troppo grande
415- Formato non supportato
500- Errore del server
502- Errore del gateway API
503- Servizio non disponibile
504- Tempo di attesa scaduto
Catalogo degli errori: ErrorResponse
Header
401
WWW-AuthenticateStringaFacoltativoSchema di autenticazione richiesto dal server.
405
AllowStringaFacoltativoMetodi HTTP supportati da questa risorsa.
429, 503
Retry-AfterInteroFacoltativoAttesa minima prima di riprovare, in secondi.
minimum:0