跳至内容
ShopentlyLearn

获取列表 · 照片

查看和预览文章照片

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

身份验证
Bearer
最低套餐
BASIC
所需的已安装模块
shopently.blog · 模块契约版本 1
所需权限
addon.shopently.blog:media_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/media?limit=10'

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/media?limit=10');
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/media?limit=10', 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

JSON
{
  "data": [
    {
      "bytes": 366,
      "created_at": "2026-10-07T23:17:43.893580Z",
      "expires_at": "2026-10-14T23:17:43.893580Z",
      "height": 100,
      "id": "e8663afe-3c38-461c-a142-a980085630af",
      "mime_type": "image/webp",
      "state": "ready",
      "variants": {
        "card": {
          "bytes": 122,
          "height": 100,
          "width": 200
        },
        "original": {
          "bytes": 122,
          "height": 100,
          "width": 200
        },
        "thumbnail": {
          "bytes": 122,
          "height": 100,
          "width": 200
        }
      },
      "version": 1,
      "width": 200
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 10,
      "next_cursor": null
    },
    "request_id": "18046f72-d201-405f-b4ab-66644766b4df"
  }
}

概览

使用 HTML 文章、照片、作者信息和搜索元数据经营店铺博客。保存草稿、准备翻译,并立即发布或安排在指定时区的所选时间发布。在面板中管理评论和审核;外部生成工具可以通过已授予权限的 API 进行操作。

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

参数

查询参数

limit整数可选

此页记录数上限。

minimum: 1maximum: 100
默认值: 50示例: 10
cursor字符串 null可选

上一页返回的不透明续页值。

字符串:maxLength: 512

此操作不接受 JSON 请求体。

响应

响应 200

data数组 <对象附加字段: 否> 必填

成功响应的数据。

maxItems: 100
字段 · data

对象附加字段: 否

bytes整数必填

大小(字节)

minimum: 1maximum: 15728640
created_at字符串必填

创建时间。

format: "date-time"
expires_at字符串 null必填

凭据到期的日期和时间。

字符串:format: "date-time"
height整数必填

高度

minimum: 1maximum: 1600
id字符串必填

资源标识符;请保留返回的原值。

format: "uuid"
mime_type字符串必填

媒体内容类型。

const: "image/webp"
state字符串必填

状态

约束
enum
["staged", "ready"]
variants对象附加字段: 否必填

照片 · variants (WebP)

version整数必填

用于并发控制的资源版本。

minimum: 1maximum: 9223372036854775807
width整数必填

宽度

minimum: 1maximum: 1600
meta对象附加字段: 否必填

响应元数据。

字段 · meta
pagination对象附加字段: 否必填

游标分页元数据。

字段 · pagination
has_more布尔值必填

是否还有下一页。

limit整数必填

此页记录数上限。

minimum: 1maximum: 100
next_cursor字符串 null必填

下一页续页值,或 null。

字符串:maxLength: 512
request_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