Перейти до вмісту
ShopentlyLearn

Завантажувати фотографії статей

Статті, автори, модеровані коментарі та заплановані публікації.

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

Автентифікація
Bearer
Доступно починаючи з
BASIC
Потрібний установлений модуль
shopently.blog · Версія контракту модуля 1
Потрібні дозволи
addon.shopently.blog:media_upload

Приклади коду

Приклад запиту

cURL

: "${SHOPENTLY_SHOP_URL:?}"

case "${SHOPENTLY_IMAGE_FILE:?}" in *[!a-zA-Z0-9/._\ -]*) echo "Unsupported image path" >&2; exit 1;; esac

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-3ccd36e66a3647eaaf03bf4cddfb471a' \
  --form "file=@${SHOPENTLY_IMAGE_FILE:?};filename=article.png;type=image/png" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/media

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-3ccd36e66a3647eaaf03bf4cddfb471a'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/media');
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);
    },
]);
$image = getenv('SHOPENTLY_IMAGE_FILE') ?: '';
if (!is_file($image) || !is_readable($image) || filesize($image) > 5242880) {
    throw new RuntimeException('Expected a readable PNG image up to 5 MiB');
}
curl_setopt($handle, CURLOPT_POSTFIELDS, ['file' => new CURLFile($image, 'image/png', 'article.png')]);
$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-3ccd36e66a3647eaaf03bf4cddfb471a'}
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 True:
        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/media', 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))

Приклад відповіді 201

JSON
{
  "data": {
    "bytes": 366,
    "height": 100,
    "id": "e8663afe-3c38-461c-a142-a980085630af",
    "version": 1,
    "width": 200
  },
  "meta": {
    "request_id": "56412902-d48f-42a2-a128-8f3cc940c768"
  }
}

Огляд

Ведіть блог магазину зі статтями HTML, фотографіями, авторами та метаданими для пошукових систем. Зберігайте чернетки, готуйте переклади й публікуйте відразу або в обраний час певного часового поясу. Керуйте коментарями й модерацією в панелі; зовнішній генератор може використовувати API з наданими правами.

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

Параметри

Заголовки запиту

Idempotency-KeyРядокОбов’язкове

Унікальний ідентифікатор однієї логічної операції запису.

minLength: 1maxLength: 128
Обмеження
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Приклад: "learn-3ccd36e66a3647eaaf03bf4cddfb471a"

Тіло запиту

multipart/form-data · Обов’язкове

Об’єктДодаткові поля: Ні
fileРядокОбов’язкове

Фотографія (PNG; multipart/form-data)

format: "binary"

Відповіді

Відповідь 201

dataОб’єктДодаткові поля: НіОбов’язкове

Дані успішної відповіді.

Поля · data
bytesЦіле числоОбов’язкове

Розмір у байтах

minimum: 1maximum: 15728640
heightЦіле числоОбов’язкове

Висота

minimum: 1maximum: 1600
idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

format: "uuid"
versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

minimum: 1maximum: 9223372036854775807
widthЦіле числоОбов’язкове

Ширина

minimum: 1maximum: 1600
metaОб’єктДодаткові поля: НіОбов’язкове

Метадані відповіді.

Поля · meta
request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100
Приклад відповіді

Статус HTTP

201
Ресурс створено Схема
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