Списък · Автори
Преглед на авторите на статии
GET/api/v1/addons/shopently.blog/authors
- Удостоверяване
Bearer- Достъпно от
- BASIC
- Необходим инсталиран модул
shopently.blog· Версия на договора на модула 1- Необходими права
addon.shopently.blog:author_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/authors?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/authors?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/authors?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
{
"data": [
{
"biography_preview": "Guides prepared by our editorial team.",
"display_name": "Store editorial team",
"id": "341494e0-caab-4f47-a8ff-f6795c42a775",
"is_active": true,
"version": 1
}
],
"meta": {
"pagination": {
"has_more": false,
"limit": 10,
"next_cursor": null
},
"request_id": "6cb2a484-9612-473c-bbc7-deece9a4dd7d"
}
}
Преглед
Водете блог на магазина с HTML статии, снимки, автори и метаданни за търсачки. Запазвайте чернови, подготвяйте преводи и публикувайте веднага или в избран час и часова зона. Управлявайте коментарите и модерирането в панела; външен генератор може да използва API с предоставените права.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:author_read
Параметри
Параметри на заявката
limitЦяло числоНезадължителноМаксимален брой записи на тази страница.
minimum:1maximum:100cursorНиз nullНезадължителноНепрозрачна стойност за продължаване, върната от предишната страница.
Низ:maxLength:512
Тази операция не приема JSON тяло.
Отговори
Отговор 200
dataМасив <ОбектДопълнителни полета: Не> ЗадължителноДанни на успешния отговор.
maxItems:100Полета ·
dataОбектДопълнителни полета: Не
biography_previewНизЗадължителноБиография
maxLength:250display_nameНизЗадължителноИме
minLength:1maxLength:160idНизЗадължителноИдентификатор на ресурса; запазете го във върнатия вид.
format:"uuid"is_activeБулева стойностЗадължителноАктивен
versionЦяло числоЗадължителноВерсия на ресурса за контрол на едновременни записи.
minimum:1maximum:9223372036854775807
metaОбектДопълнителни полета: НеЗадължителноМетаданни на отговора.
Полета ·
metapaginationОбектДопълнителни полета: НеЗадължителноМетаданни за страниране с cursor.
Полета ·
paginationhas_moreБулева стойностЗадължителноДали има следваща страница.
limitЦяло числоЗадължителноМаксимален брой записи на тази страница.
minimum:1maximum:100next_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