文章
阅读文章和预览草稿
GET/api/v1/addons/shopently.blog/posts/{post_id}
- 身份验证
Bearer- 最低套餐
- BASIC
- 所需的已安装模块
shopently.blog· 模块契约版本 1- 所需权限
addon.shopently.blog:post_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/posts/2103ba96-2713-420b-b197-8a008730c851?locale=pl'
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/posts/2103ba96-2713-420b-b197-8a008730c851?locale=pl');
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/posts/2103ba96-2713-420b-b197-8a008730c851?locale=pl', 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": {
"author_id": "341494e0-caab-4f47-a8ff-f6795c42a775",
"comments_mode": "open",
"content_html": "<h2>Porównaj właściwości</h2><p>Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.</p>",
"cover_alt": "Niebieska ilustracja poradnika",
"cover_caption": "Ilustracja redakcyjna",
"cover_media_id": "e8663afe-3c38-461c-a142-a980085630af",
"draft_revision_id": "8c4af6da-63f4-42aa-8b37-57c703fa0af7",
"excerpt": "Praktyczny poradnik zakupowy.",
"first_published_at": null,
"id": "2103ba96-2713-420b-b197-8a008730c851",
"last_published_at": null,
"locale": "pl",
"meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.",
"meta_keywords": [
"poradnik",
"wybór"
],
"meta_title": "Jak wybrać produkt",
"public_number": 1,
"publish_at": null,
"publish_timezone": null,
"published_revision_id": null,
"schedule_state": null,
"scheduled_revision_id": null,
"slug": "jak-wybrac-produkt",
"status": "draft",
"title": "Jak wybrać produkt",
"updated_at": "2026-10-07T23:17:44.320869Z",
"version": 1
},
"meta": {
"request_id": "c85f6074-44e5-4d74-a117-fb631879fb7d"
}
}
概览
使用 HTML 文章、照片、作者信息和搜索元数据经营店铺博客。保存草稿、准备翻译,并立即发布或安排在指定时区的所选时间发布。在面板中管理评论和审核;外部生成工具可以通过已授予权限的 API 进行操作。
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:post_read
参数
路径参数
post_id字符串必填文章
format:"uuid"
查询参数
locale字符串必填本次请求选择的语言。
minLength:2maxLength:35约束
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
此操作不接受 JSON 请求体。
响应
响应 200
data对象附加字段: 否必填成功响应的数据。
字段 ·
dataauthor_id字符串 null必填操作人
字符串:format:"uuid"comments_mode字符串必填评论
约束
enum["inherit", "open", "closed"]
content_html字符串必填内容
maxLength:50000cover_alt字符串必填替代文本
maxLength:250cover_caption字符串必填照片说明
maxLength:500cover_media_id字符串 null必填封面照片
字符串:format:"uuid"draft_revision_id字符串必填草稿版本
format:"uuid"excerpt字符串必填简介
maxLength:1000first_published_at字符串 null必填首次发布
字符串:format:"date-time"id字符串必填资源标识符;请保留返回的原值。
format:"uuid"last_published_at字符串 null必填最近发布
字符串:format:"date-time"locale字符串必填本次请求选择的语言。
minLength:2maxLength:35约束
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_description字符串必填所选语言的搜索引擎描述。
maxLength:160meta_keywords数组 <字符串> 必填所选语言的搜索引擎关键词。
maxItems:20数组:minLength:1maxLength:50meta_title字符串必填所选语言的搜索引擎标题。
maxLength:70public_number整数必填编号
minimum:1publish_at字符串 null必填发布日期
字符串:format:"date-time"publish_timezone字符串 null必填时区
字符串:maxLength:64published_revision_id字符串 null必填版本 (已发布)
字符串:format:"uuid"schedule_state字符串 null必填定时发布
约束 · 字符串 1
enum["armed", "requires_confirmation"]
scheduled_revision_id字符串 null必填版本 (已排期)
字符串:format:"uuid"slug字符串必填所选语言的 URL 路径段。
maxLength:160status字符串必填此操作接受的状态。
约束
enum["draft", "scheduled", "published", "archived"]
title字符串必填所选语言的标题。
maxLength:200updated_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