Treci la conținut
ShopentlyLearn

Listează · Articole

Citirea articolelor și previzualizarea ciornelor

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

Autentificare
Bearer
Disponibil începând cu
BASIC
Modul instalat necesar
shopently.blog · Versiunea contractului modulului 1
Permisiuni necesare
addon.shopently.blog:post_read

Exemple de cod

Exemplu de cerere

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/posts?limit=10&locale=pl&status=draft'

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/posts?limit=10&locale=pl&status=draft');
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/posts?limit=10&locale=pl&status=draft', 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))

Exemplu de răspuns 200

JSON
{
  "data": [
    {
      "author_name": "Store editorial team",
      "cover_alt": "Niebieska ilustracja poradnika",
      "cover_media_id": "e8663afe-3c38-461c-a142-a980085630af",
      "first_published_at": null,
      "id": "2103ba96-2713-420b-b197-8a008730c851",
      "public_number": 1,
      "publish_at": null,
      "status": "draft",
      "title": "Jak wybrać produkt",
      "updated_at": "2026-10-07T23:17:44.320869Z",
      "version": 1
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 10,
      "next_cursor": null
    },
    "request_id": "56b810d9-7dfa-4bc5-8928-0af90d80dbda"
  }
}

Prezentare generală

Gestionează blogul magazinului cu articole HTML, fotografii, autori și metadate pentru motoarele de căutare. Salvează ciorne, pregătește traduceri și publică imediat sau la o oră aleasă într-un anumit fus orar. Gestionează comentariile și moderarea în panou; un generator extern poate folosi API-ul cu permisiunile acordate.

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

Parametri

Parametri de interogare

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

minLength: 2maxLength: 35
Restricții
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Exemplu: "pl"
limitNumăr întregOpțional

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100
Valoare implicită: 50Exemplu: 10
cursorȘir de caractere nullOpțional

Valoare opacă de continuare returnată de pagina anterioară.

Șir de caractere:maxLength: 512
statusȘir de caractere nullOpțional

Starea acceptată de această operație specifică.

Restricții · Șir de caractere 1
enum
["draft", "scheduled", "published", "archived"]
Exemplu: "draft"
titleȘir de caractere nullOpțional

Titlul în limba selectată.

Șir de caractere:maxLength: 200
author_idȘir de caractere nullOpțional

Autor

Șir de caractere:format: "uuid"
publish_fromȘir de caractere nullOpțional

Publicat începând cu

Șir de caractere:format: "date-time"
publish_toȘir de caractere nullOpțional

Publicat înainte de

Șir de caractere:format: "date-time"

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

dataTablou <ObiectCâmpuri suplimentare: Nu> Obligatoriu

Datele unui răspuns reușit.

maxItems: 100
Câmpuri · data

ObiectCâmpuri suplimentare: Nu

author_nameȘir de caractereObligatoriu

Autor

maxLength: 160
cover_altȘir de caractereObligatoriu

Text alternativ

maxLength: 250
cover_media_idȘir de caractere nullObligatoriu

Fotografie de copertă

Șir de caractere:format: "uuid"
first_published_atȘir de caractere nullObligatoriu

Prima publicare

Șir de caractere:format: "date-time"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

format: "uuid"
public_numberNumăr întregObligatoriu

Număr

minimum: 1
publish_atȘir de caractere nullObligatoriu

Data publicării

Șir de caractere:format: "date-time"
statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Restricții
enum
["draft", "scheduled", "published", "archived"]
titleȘir de caractereObligatoriu

Titlul în limba selectată.

maxLength: 200
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

minimum: 1maximum: 9223372036854775807
metaObiectCâmpuri suplimentare: NuObligatoriu

Metadatele răspunsului.

Câmpuri · meta
paginationObiectCâmpuri suplimentare: NuObligatoriu

Metadatele paginării prin cursor.

Câmpuri · pagination
has_moreValoare booleanăObligatoriu

Indică dacă există o pagină următoare.

limitNumăr întregObligatoriu

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100
next_cursorȘir de caractere nullObligatoriu

Valoare de continuare pentru pagina următoare sau null.

Șir de caractere:maxLength: 512
request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu de răspuns

Stare HTTP

200
Răspuns reușit Schemă
400
Cerere nevalidă
401
Autentificare necesară
403
Acces refuzat
404
Resursa nu a fost găsită
409
Conflict de versiune
422
Validare eșuată
429
Limită de cereri depășită
Alte stări HTTP (7)
405
Metodă nepermisă
413
Cerere prea mare
415
Format neacceptat
500
Eroare de server
502
Eroare de gateway API
503
Serviciu indisponibil
504
Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional

Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional

Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional

Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0