Saltar al contenido
ShopentlyLearn

Subir fotos de artículos

Artículos, autores, comentarios moderados y publicación programada.

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

Autenticación
Bearer
Disponible desde
BASIC
Módulo instalado requerido
shopently.blog · Versión del contrato del módulo 1
Permisos necesarios
addon.shopently.blog:media_upload

Ejemplos de código

Ejemplo de solicitud

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))

Ejemplo de respuesta 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"
  }
}

Vista general

Administra el blog de tu tienda con artículos HTML, fotos, autores y metadatos para buscadores. Guarda borradores, prepara traducciones y publica de inmediato o a una hora elegida en una zona horaria específica. Administra los comentarios y su moderación en el panel; un generador externo puede usar la API con los permisos que otorgues.

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

Parámetros

Encabezados de solicitud

Idempotency-KeyCadena de textoObligatorio

Identificador único de una operación lógica de escritura.

minLength: 1maxLength: 128
Restricciones
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Ejemplo: "learn-3ccd36e66a3647eaaf03bf4cddfb471a"

Cuerpo de la solicitud

multipart/form-data · Obligatorio

ObjetoCampos adicionales: No
fileCadena de textoObligatorio

Foto (PNG; multipart/form-data)

format: "binary"

Respuestas

Respuesta 201

dataObjetoCampos adicionales: NoObligatorio

Contenido de una respuesta correcta.

Campos · data
bytesNúmero enteroObligatorio

Tamaño en bytes

minimum: 1maximum: 15728640
heightNúmero enteroObligatorio

Alto

minimum: 1maximum: 1600
idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve.

format: "uuid"
versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

minimum: 1maximum: 9223372036854775807
widthNúmero enteroObligatorio

Ancho

minimum: 1maximum: 1600
metaObjetoCampos adicionales: NoObligatorio

Metadatos de la respuesta.

Campos · meta
request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100
Ejemplo de respuesta

Estado HTTP

201
Recurso creado Esquema
400
Solicitud no válida
401
Autenticación necesaria
403
Permiso denegado
404
Recurso no encontrado
409
Conflicto de versión
422
Error de validación
429
Límite de solicitudes excedido
Otros estados HTTP (7)
405
Método no permitido
413
Solicitud demasiado grande
415
Formato no compatible
500
Error del servidor
502
Error de la puerta de enlace API
503
Servicio no disponible
504
Tiempo de espera agotado

Catálogo de errores: ErrorResponse

Cabeceras

401

WWW-AuthenticateCadena de textoOpcional

Esquema de autenticación exigido por el servidor.

405

AllowCadena de textoOpcional

Métodos HTTP admitidos por este recurso.

429, 503

Retry-AfterNúmero enteroOpcional

Espera mínima antes de reintentar, en segundos.

minimum: 0