照片 · WebP
檢視與預覽文章照片
GET/api/v1/addons/shopently.blog/media/{media_id}/file
- 身份驗證
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:?}" \
--max-filesize 5242880 \
--output "${SHOPENTLY_OUTPUT_FILE:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/addons/shopently.blog/media/e8663afe-3c38-461c-a142-a980085630af/file?variant=thumbnail'
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/e8663afe-3c38-461c-a142-a980085630af/file?variant=thumbnail');
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'] ?? ''));
}
if (($responseHeaders['content-type'] ?? '') !== 'image/webp' || strlen($raw) > 5242880) {
throw new RuntimeException('Unexpected image response');
}
$output = fopen(getenv('SHOPENTLY_OUTPUT_FILE') ?: '', 'xb');
if ($output === false) { throw new RuntimeException('Cannot create image output'); }
try {
if (fwrite($output, $raw) !== strlen($raw)) { throw new RuntimeException('Incomplete image write'); }
} finally { fclose($output); }
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/e8663afe-3c38-461c-a142-a980085630af/file?variant=thumbnail', 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 True:
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
Content-Type: image/webp
Content-Disposition: inline; filename="image.webp"
概覽
使用 HTML 文章、照片、作者資訊與搜尋中繼資料經營商店部落格。儲存草稿、準備翻譯,並立即發布或排程於指定時區的所選時間發布。在面板中管理留言與審核;外部生成工具可以透過已授予權限的 API 進行操作。
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:media_read
參數
路徑參數
media_id字串必填所選圖片資產的識別碼。
format:"uuid"
查詢參數
variant字串選填由允許值說明的資料結構變體。
約束
enum["original", "card", "thumbnail"]
此操作不接受 JSON 請求本文。
回應
回應 200
回應示例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