댓글
댓글 및 검토 상태 읽기
GET/api/v1/addons/shopently.blog/comments/{comment_id}
- 인증
Bearer- 최소 요금제
- BASIC
- 필요한 설치 모듈
shopently.blog· 모듈 계약 버전 1- 필수 권한
addon.shopently.blog:comment_read
코드 예제
요청 예제
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))
응답 예제 200
{
"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"
}
}
개요
HTML 글, 사진, 작성자 정보와 검색 메타데이터로 스토어 블로그를 운영하세요. 초안과 번역을 준비하고 즉시 게시하거나 특정 시간대의 원하는 시각에 게시하도록 예약할 수 있습니다. 패널에서 댓글과 검토를 관리하며, 외부 생성 도구는 부여한 권한으로 API를 사용할 수 있습니다.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:comment_read
매개변수
경로 매개변수
comment_id문자열필수리소스 식별자이며 반환된 값을 그대로 유지해야 합니다.
format:"uuid"
이 작업은 JSON 본문을 받지 않습니다.
응답
응답 200
data객체추가 필드: 아니요필수성공 응답의 데이터입니다.
필드 ·
dataactor_id문자열필수작업자 식별자
minLength:1maxLength:63actor_kind문자열필수작업자 유형
제약 조건
enum["administrator", "customer", "api"]
body문자열필수댓글
minLength:1maxLength:5000created_at문자열필수생성 시각입니다.
format:"date-time"display_name문자열필수이름
minLength:1maxLength:160edited_at문자열 null필수수정됨
문자열:format:"date-time"id문자열필수리소스 식별자이며 반환된 값을 그대로 유지해야 합니다.
format:"uuid"locale문자열필수이 요청에서 선택한 언어입니다.
minLength:2maxLength:35제약 조건
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
moderation_reason문자열 null필수검토 사유
문자열:maxLength:500post_id문자열필수글
format:"uuid"status문자열필수이 작업에서 허용하는 상태입니다.
제약 조건
enum["pending", "approved", "rejected", "spam"]
updated_at문자열필수가장 최근 업데이트 시각입니다.
format:"date-time"version정수필수동시성 제어에 사용하는 리소스 버전입니다.
minimum:1maximum:9223372036854775807
meta객체추가 필드: 아니요필수응답 메타데이터입니다.
필드 ·
metarequest_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
HTTP 상태
200- 성공 응답 스키마
400- 잘못된 요청
401- 인증 필요
403- 권한 없음
404- 리소스를 찾을 수 없음
409- 버전 충돌
422- 유효성 검사 실패
429- 요청 한도 초과
기타 HTTP 상태 (7)
405- 허용되지 않은 메서드
413- 요청이 너무 큼
415- 지원하지 않는 형식
500- 서버 오류
502- API 게이트웨이 오류
503- 서비스 이용 불가
504- 시간 초과
오류 목록: ErrorResponse
헤더
401
WWW-Authenticate문자열선택 사항서버가 요구하는 인증 방식입니다.
405
Allow문자열선택 사항이 리소스가 지원하는 HTTP 메서드입니다.
429, 503
Retry-After정수선택 사항재시도 전에 기다려야 하는 최소 시간(초)입니다.
minimum:0