Moderate comment
Approve, reject and moderate comments
POST/api/v1/addons/shopently.blog/comments/{comment_id}/moderate
- Authentication
Bearer- Available from
- BASIC
- Required installed module
shopently.blog· Module contract version 1- Required permissions
addon.shopently.blog:comment_moderate
Code examples
Request example
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-4684eba9bb8e4afba9bb54c76e71e04d' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 2,
"reason": null,
"status": "approved"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/comments/2247b58d-1521-4fc0-9eec-6c47c259c181/moderate
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-4684eba9bb8e4afba9bb54c76e71e04d', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/comments/2247b58d-1521-4fc0-9eec-6c47c259c181/moderate');
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, '{
"expected_version": 2,
"reason": null,
"status": "approved"
}');
$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-4684eba9bb8e4afba9bb54c76e71e04d'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "expected_version": 2,\n "reason": null,\n "status": "approved"\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/2247b58d-1521-4fc0-9eec-6c47c259c181/moderate', 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))
Response example 200
{
"data": {
"id": "2247b58d-1521-4fc0-9eec-6c47c259c181",
"status": "approved",
"version": 3
},
"meta": {
"request_id": "b2f16d9f-4ef9-4f9e-9ff1-ec46da1aadf8"
}
}
Overview
Run your store’s blog with HTML articles, photos, authors and search metadata. Save drafts, prepare translations and publish immediately or at a chosen time in a specific time zone. Manage comments and moderation in the panel; an external generator can use the API with the permissions you grant.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:comment_moderate
Parameters
Path parameters
comment_idStringRequiredResource identifier; preserve it as returned.
format:"uuid"
Request headers
Idempotency-KeyStringRequiredUnique identifier for one logical write operation.
minLength:1maxLength:128Constraints
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Request body
application/json · Required
expected_versionIntegerRequiredVersion read before the write; a mismatch rejects the update.
minimum:1maximum:9223372036854775807reasonString nullOptionalReason recorded for the change.
String:maxLength:500statusStringRequiredStatus accepted by this specific operation.
Constraints
enum["pending", "approved", "rejected", "spam"]
Responses
Response 200
dataObjectAdditional fields: NoRequiredSuccessful response payload.
Fields ·
dataidStringRequiredResource identifier; preserve it as returned.
format:"uuid"statusStringRequiredStatus accepted by this specific operation.
Constraints
enum["pending", "approved", "rejected", "spam"]
versionIntegerRequiredResource version used for concurrency control.
minimum:1maximum:9223372036854775807
metaObjectAdditional fields: NoRequiredResponse metadata.
Fields ·
metarequest_idStringRequiredRequest identifier; in response metadata this identifies the HTTP request.
minLength:1maxLength:100
HTTP status
200- Successful response Schema
400- Invalid request
401- Authentication required
403- Permission denied
404- Resource not found
409- Version conflict
422- Validation failed
429- Rate limit exceeded
Other HTTP statuses (7)
405- Method not allowed
413- Request too large
415- Unsupported media type
500- Server error
502- API gateway error
503- Service unavailable
504- Gateway timeout
Error catalog: ErrorResponse
Headers
401
WWW-AuthenticateStringOptionalAuthentication scheme required by the server.
405
AllowStringOptionalHTTP methods supported by this resource.
429, 503
Retry-AfterIntegerOptionalMinimum delay before retrying, in seconds.
minimum:0