Saltar para o conteúdo
ShopentlyLearn

Listar · Fotografias

Consultar e pré-visualizar fotografias dos artigos

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

Autenticação
Bearer
Disponível a partir de
BASIC
Módulo instalado necessário
shopently.blog · Versão do contrato do módulo 1
Permissões necessárias
addon.shopently.blog:media_read

Exemplos de código

Exemplo de requisição

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/media?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/media?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/media?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))

Exemplo de resposta 200

JSON
{
  "data": [
    {
      "bytes": 366,
      "created_at": "2026-10-07T23:17:43.893580Z",
      "expires_at": "2026-10-14T23:17:43.893580Z",
      "height": 100,
      "id": "e8663afe-3c38-461c-a142-a980085630af",
      "mime_type": "image/webp",
      "state": "ready",
      "variants": {
        "card": {
          "bytes": 122,
          "height": 100,
          "width": 200
        },
        "original": {
          "bytes": 122,
          "height": 100,
          "width": 200
        },
        "thumbnail": {
          "bytes": 122,
          "height": 100,
          "width": 200
        }
      },
      "version": 1,
      "width": 200
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 10,
      "next_cursor": null
    },
    "request_id": "18046f72-d201-405f-b4ab-66644766b4df"
  }
}

Visão geral

Gira o blogue da sua loja com artigos HTML, fotografias, autores e metadados para motores de pesquisa. Guarde rascunhos, prepare traduções e publique de imediato ou a uma hora escolhida num fuso horário específico. Gira comentários e moderação no painel; um gerador externo pode utilizar a API com as permissões concedidas.

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

Parâmetros

Parâmetros de consulta

limitNúmero inteiroOpcional

Número máximo de registos nesta página.

minimum: 1maximum: 100
Predefinido: 50Exemplo: 10
cursorTexto nullOpcional

Valor opaco de continuação retornado pela página anterior.

Texto:maxLength: 512

Esta operação não aceita um corpo JSON.

Respostas

Resposta 200

dataLista <ObjetoCampos adicionais: Não> Obrigatório

Conteúdo de uma resposta bem-sucedida.

maxItems: 100
Campos · data

ObjetoCampos adicionais: Não

bytesNúmero inteiroObrigatório

Tamanho em bytes

minimum: 1maximum: 15728640
created_atTextoObrigatório

Momento da criação.

format: "date-time"
expires_atTexto nullObrigatório

Data e hora de expiração da credencial.

Texto:format: "date-time"
heightNúmero inteiroObrigatório

Altura

minimum: 1maximum: 1600
idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"
mime_typeTextoObrigatório

Tipo de conteúdo da multimédia.

const: "image/webp"
stateTextoObrigatório

Estado

Restrições
enum
["staged", "ready"]
variantsObjetoCampos adicionais: NãoObrigatório

Fotografia · variants (WebP)

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

minimum: 1maximum: 9223372036854775807
widthNúmero inteiroObrigatório

Largura

minimum: 1maximum: 1600
metaObjetoCampos adicionais: NãoObrigatório

Metadados da resposta.

Campos · meta
paginationObjetoCampos adicionais: NãoObrigatório

Metadados da paginação por cursor.

Campos · pagination
has_moreBooleanoObrigatório

Indica se há outra página disponível.

limitNúmero inteiroObrigatório

Número máximo de registos nesta página.

minimum: 1maximum: 100
next_cursorTexto nullObrigatório

Valor de continuação da próxima página, ou null.

Texto:maxLength: 512
request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Pedido inválido
401
Autenticação necessária
403
Permissão negada
404
Recurso não encontrado
409
Conflito de versão
422
Falha na validação
429
Limite de pedidos excedido
Outros estados HTTP (7)
405
Método não permitido
413
Pedido demasiado grande
415
Formato não suportado
500
Erro do servidor
502
Erro do gateway da API
503
Serviço indisponível
504
Tempo de espera excedido

Catálogo de erros: ErrorResponse

Cabeçalhos

401

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0