Gå til innhold
ShopentlyLearn

Ny kommentar

Opprette redaksjonelle kommentarer

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

Autentisering
Bearer
Tilgjengelig fra
BASIC
Påkrevd installert modul
shopently.blog · Modulets kontraktversjon 1
Nødvendige tilganger
addon.shopently.blog:comment_create

Kodeeksempler

Eksempel på forespørsel

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: learn-e53442b24a8748e79c202f8ad4c82b9e' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "body": "Zapraszamy do zadawania pytań.",
  "display_name": "Redakcja",
  "locale": "pl",
  "post_id": "2103ba96-2713-420b-b197-8a008730c851"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/comments

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 = ['Idempotency-Key: learn-e53442b24a8748e79c202f8ad4c82b9e', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/comments');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    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);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
  "body": "Zapraszamy do zadawania pytań.",
  "display_name": "Redakcja",
  "locale": "pl",
  "post_id": "2103ba96-2713-420b-b197-8a008730c851"
}');
$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 = {'Idempotency-Key': 'learn-e53442b24a8748e79c202f8ad4c82b9e'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "body": "Zapraszamy do zadawania pytań.",\n  "display_name": "Redakcja",\n  "locale": "pl",\n  "post_id": "2103ba96-2713-420b-b197-8a008730c851"\n}'
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(
        'POST', base_url + '/api/v1/addons/shopently.blog/comments', 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 201

JSON
{
  "data": {
    "id": "2247b58d-1521-4fc0-9eec-6c47c259c181",
    "status": "approved",
    "version": 1
  },
  "meta": {
    "request_id": "75ae817c-2925-48e0-ab57-1216a6e4ed45"
  }
}

Oversikt

Driv butikkens blogg med HTML-artikler, bilder, forfattere og metadata for søkemotorer. Lagre utkast, klargjør oversettelser og publiser straks eller på et valgt tidspunkt i en bestemt tidssone. Administrer kommentarer og moderering i panelet; en ekstern generator kan bruke API-et med rettighetene du tildeler.

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

Parametere

Forespørselshoder

Idempotency-KeyStrengObligatorisk

Unik identifikator for én logisk skriveoperasjon.

minLength: 1maxLength: 128
Begrensninger
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Eksempel: "learn-e53442b24a8748e79c202f8ad4c82b9e"

Forespørselsinnhold

application/json · Obligatorisk

ObjektYtterligere felt: Nei
bodyStrengObligatorisk

Kommentar

minLength: 1maxLength: 5000
display_nameStrengObligatorisk

Navn

minLength: 1maxLength: 160
expected_versionHeltallValgfritt

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

const: 1
Standard: 1
localeStrengObligatorisk

Språk valgt for denne forespørselen.

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

Artikkel

format: "uuid"

Svar

Svar 201

dataObjektYtterligere felt: NeiObligatorisk

Innholdet i et vellykket svar.

Felter · data
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

format: "uuid"
statusStrengObligatorisk

Status som godtas av denne bestemte operasjonen.

Begrensninger
enum
["pending", "approved", "rejected", "spam"]
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

minimum: 1maximum: 9223372036854775807
metaObjektYtterligere felt: NeiObligatorisk

Svarmetadata.

Felter · meta
request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

201
Ressurs opprettet Skjema
400
Ugyldig forespørsel
401
Autentisering kreves
403
Tilgang nektet
404
Ressursen ble ikke funnet
409
Versjonskonflikt
422
Validering mislyktes
429
Forespørselsgrensen er overskredet
Andre HTTP-statuser (7)
405
Metoden er ikke tillatt
413
Forespørselen er for stor
415
Formatet støttes ikke
500
Serverfeil
502
Feil i API-gateway
503
Tjenesten er utilgjengelig
504
Tidsavbrudd

Feilkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfritt

Autentiseringsmetode serveren krever.

405

AllowStrengValgfritt

HTTP-metoder denne ressursen støtter.

429, 503

Retry-AfterHeltallValgfritt

Minste ventetid før neste forsøk, i sekunder.

minimum: 0