Gå til indhold
ShopentlyLearn

Kommentar

Læs kommentarer og moderationsstatus

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

Godkendelse
Bearer
Tilgængelig fra
BASIC
Påkrævet installeret modul
shopently.blog · Modulets kontraktversion 1
Nødvendige rettigheder
addon.shopently.blog:comment_read

Kodeeksempler

Eksempel på forespørgsel

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

Eksempel på svar 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"
  }
}

Oversigt

Driv butikkens blog med HTML-artikler, fotos, forfattere og metadata til søgemaskiner. Gem kladder, klargør oversættelser, og udgiv straks eller på et valgt tidspunkt i en bestemt tidszone. Administrer kommentarer og moderation i panelet; en ekstern generator kan bruge API’et med de rettigheder, du tildeler.

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

Parametre

Stiparametre

comment_idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

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

Denne operation accepterer ikke JSON-indhold.

Svar

Svar 200

dataObjektYderligere felter: NejObligatorisk

Indholdet af et vellykket svar.

Felter · data
actor_idStrengObligatorisk

Aktøridentifikator

minLength: 1maxLength: 63
actor_kindStrengObligatorisk

Aktørtype

Begrænsninger
enum
["administrator", "customer", "api"]
bodyStrengObligatorisk

Kommentar

minLength: 1maxLength: 5000
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
display_nameStrengObligatorisk

Navn

minLength: 1maxLength: 160
edited_atStreng nullObligatorisk

Redigeret

Streng:format: "date-time"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

minLength: 2maxLength: 35
Begrænsninger
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
moderation_reasonStreng nullObligatorisk

Årsag til moderation

Streng:maxLength: 500
post_idStrengObligatorisk

Artikel

format: "uuid"
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["pending", "approved", "rejected", "spam"]
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

minimum: 1maximum: 9223372036854775807
metaObjektYderligere felter: NejObligatorisk

Svarmetadata.

Felter · meta
request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0