Zum Inhalt springen
ShopentlyLearn

Auflisten · Kommentare

Kommentare und Moderationsstatus lesen

GET/api/v1/addons/shopently.blog/comments

Authentifizierung
Bearer
Verfügbar ab
BASIC
Erforderliches installiertes Modul
shopently.blog · Vertragsversion des Moduls 1
Erforderliche Berechtigungen
addon.shopently.blog:comment_read

Codebeispiele

Beispielanfrage

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

Beispielantwort 200

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

Übersicht

Führe den Blog deines Shops mit HTML-Artikeln, Fotos, Autoren und Suchmaschinen-Metadaten. Speichere Entwürfe, erstelle Übersetzungen und veröffentliche sofort oder zu einem gewählten Zeitpunkt in einer bestimmten Zeitzone. Verwalte Kommentare und Moderation im Panel; ein externer Generator kann die API mit den erteilten Berechtigungen nutzen.

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

Parameter

Abfrageparameter

limitGanzzahlOptional

Maximale Anzahl von Datensätzen auf dieser Seite.

minimum: 1maximum: 100
Standardwert: 50Beispiel: 10
cursorZeichenfolge nullOptional

Unverändert zu übernehmender Fortsetzungswert der vorherigen Seite.

Zeichenfolge:maxLength: 512
post_idZeichenfolge nullOptional

Artikel

Zeichenfolge:format: "uuid"
Beispiel: "2103ba96-2713-420b-b197-8a008730c851"
statusZeichenfolge nullOptional

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen · Zeichenfolge 1
enum
["pending", "approved", "rejected", "spam"]

Diese Operation akzeptiert keinen JSON-Inhalt.

Antworten

Antwort 200

dataArray <ObjektZusätzliche Felder: Nein> Erforderlich

Nutzdaten einer erfolgreichen Antwort.

maxItems: 100
Felder · data

ObjektZusätzliche Felder: Nein

actor_kindZeichenfolgeErforderlich

Akteurtyp

Einschränkungen
enum
["administrator", "customer", "api"]
body_previewZeichenfolgeErforderlich

Kommentar

minLength: 1maxLength: 250
created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"
display_nameZeichenfolgeErforderlich

Kategoriename

minLength: 1maxLength: 160
edited_atZeichenfolge nullErforderlich

Bearbeitet

Zeichenfolge:format: "date-time"
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

format: "uuid"
localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

minLength: 2maxLength: 35
Einschränkungen
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
post_idZeichenfolgeErforderlich

Artikel

format: "uuid"
statusZeichenfolgeErforderlich

Von dieser konkreten Operation akzeptierter Status.

Einschränkungen
enum
["pending", "approved", "rejected", "spam"]
versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

minimum: 1maximum: 9223372036854775807
metaObjektZusätzliche Felder: NeinErforderlich

Metadaten der Antwort.

Felder · meta
paginationObjektZusätzliche Felder: NeinErforderlich

Metadaten der Cursor-Paginierung.

Felder · pagination
has_moreBoolescher WertErforderlich

Gibt an, ob eine weitere Seite verfügbar ist.

limitGanzzahlErforderlich

Maximale Anzahl von Datensätzen auf dieser Seite.

minimum: 1maximum: 100
next_cursorZeichenfolge nullErforderlich

Fortsetzungswert für die nächste Seite oder null.

Zeichenfolge:maxLength: 512
request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100
Beispielantwort

HTTP-Status

200
Erfolgreiche Antwort Schema
400
Ungültige Anfrage
401
Authentifizierung erforderlich
403
Berechtigung verweigert
404
Ressource nicht gefunden
409
Versionskonflikt
422
Validierung fehlgeschlagen
429
Anfragelimit überschritten
Weitere HTTP-Statuscodes (7)
405
Methode nicht erlaubt
413
Anfrage zu groß
415
Nicht unterstützter Medientyp
500
Serverfehler
502
API-Gateway-Fehler
503
Dienst nicht verfügbar
504
Gateway-Zeitüberschreitung

Fehlerkatalog: ErrorResponse

Header

401

WWW-AuthenticateZeichenfolgeOptional

Vom Server verlangtes Authentifizierungsschema.

405

AllowZeichenfolgeOptional

Von dieser Ressource unterstützte HTTP-Methoden.

429, 503

Retry-AfterGanzzahlOptional

Mindestwartezeit vor einem erneuten Versuch in Sekunden.

minimum: 0