Treci la conținut
ShopentlyLearn

Comentariu

Citirea comentariilor și a stării moderării

GET/api/v1/addons/shopently.blog/comments/{comment_id}

Autentificare
Bearer
Disponibil începând cu
BASIC
Modul instalat necesar
shopently.blog · Versiunea contractului modulului 1
Permisiuni necesare
addon.shopently.blog:comment_read

Exemple de cod

Exemplu de cerere

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))

Exemplu de răspuns 200

JSON
{
  "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"
  }
}

Prezentare generală

Gestionează blogul magazinului cu articole HTML, fotografii, autori și metadate pentru motoarele de căutare. Salvează ciorne, pregătește traduceri și publică imediat sau la o oră aleasă într-un anumit fus orar. Gestionează comentariile și moderarea în panou; un generator extern poate folosi API-ul cu permisiunile acordate.

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

Parametri

Parametrii căii

comment_idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"
Exemplu: "2247b58d-1521-4fc0-9eec-6c47c259c181"

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

dataObiectCâmpuri suplimentare: NuObligatoriu

Datele unui răspuns reușit.

Câmpuri · data
actor_idȘir de caractereObligatoriu

Identificatorul actorului

minLength: 1maxLength: 63
actor_kindȘir de caractereObligatoriu

Tipul actorului

Restricții
enum
["administrator", "customer", "api"]
bodyȘir de caractereObligatoriu

Comentariu

minLength: 1maxLength: 5000
created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
display_nameȘir de caractereObligatoriu

Nume

minLength: 1maxLength: 160
edited_atȘir de caractere nullObligatoriu

Editat

Șir de caractere:format: "date-time"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"
localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

minLength: 2maxLength: 35
Restricții
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
moderation_reasonȘir de caractere nullObligatoriu

Motivul moderării

Șir de caractere:maxLength: 500
post_idȘir de caractereObligatoriu

Articol

format: "uuid"
statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Restricții
enum
["pending", "approved", "rejected", "spam"]
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

minimum: 1maximum: 9223372036854775807
metaObiectCâmpuri suplimentare: NuObligatoriu

Metadatele răspunsului.

Câmpuri · meta
request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu de răspuns

Stare HTTP

200
Răspuns reușit Schemă
400
Cerere nevalidă
401
Autentificare necesară
403
Acces refuzat
404
Resursa nu a fost găsită
409
Conflict de versiune
422
Validare eșuată
429
Limită de cereri depășită
Alte stări HTTP (7)
405
Metodă nepermisă
413
Cerere prea mare
415
Format neacceptat
500
Eroare de server
502
Eroare de gateway API
503
Serviciu indisponibil
504
Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional

Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional

Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional

Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0