Архівувати · Статті
Публікувати, планувати й архівувати статті
POST/api/v1/addons/shopently.blog/posts/{post_id}/archive
- Автентифікація
Bearer- Доступно починаючи з
- BASIC
- Потрібний установлений модуль
shopently.blog· Версія контракту модуля 1- Потрібні дозволи
addon.shopently.blog:post_publish
Приклади коду
Приклад запиту
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request POST \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: learn-14c6494b41f142189df2b60be2bae407' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 3
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/archive
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 = ['Idempotency-Key: learn-14c6494b41f142189df2b60be2bae407', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/archive');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'POST',
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);
},
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
"expected_version": 3
}');
$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 = {'Idempotency-Key': 'learn-14c6494b41f142189df2b60be2bae407'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "expected_version": 3\n}'
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(
'POST', base_url + '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/archive', 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": {
"id": "2103ba96-2713-420b-b197-8a008730c851",
"status": "archived",
"version": 4
},
"meta": {
"request_id": "132f5ca3-88c0-4c81-b6b2-cc8c67efc1cc"
}
}
Огляд
Ведіть блог магазину зі статтями HTML, фотографіями, авторами та метаданими для пошукових систем. Зберігайте чернетки, готуйте переклади й публікуйте відразу або в обраний час певного часового поясу. Керуйте коментарями й модерацією в панелі; зовнішній генератор може використовувати API з наданими правами.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:post_publish
Параметри
Параметри шляху
post_idРядокОбов’язковеСтаття
format:"uuid"
Заголовки запиту
Idempotency-KeyРядокОбов’язковеУнікальний ідентифікатор однієї логічної операції запису.
minLength:1maxLength:128Обмеження
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Тіло запиту
application/json · Обов’язкове
expected_versionЦіле числоОбов’язковеВерсія, прочитана перед записом; невідповідність блокує оновлення.
minimum:1maximum:9223372036854775807
Відповіді
Відповідь 200
dataОб’єктДодаткові поля: НіОбов’язковеДані успішної відповіді.
Поля ·
dataidРядокОбов’язковеІдентифікатор ресурсу; зберігайте його в отриманому вигляді.
format:"uuid"statusРядокОбов’язковеСтатус, допустимий для цієї конкретної операції.
Обмеження
enum["draft", "scheduled", "published", "archived"]
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