Přejít na obsah
ShopentlyLearn

Vypsat · Články

Číst články a zobrazovat náhledy konceptů

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

Ověřování
Bearer
Dostupné od tarifu
BASIC
Vyžadovaný nainstalovaný modul
shopently.blog · Verze kontraktu modulu 1
Požadovaná oprávnění
addon.shopently.blog:post_read

Příklady kódu

Příklad požadavku

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

Příklad odpovědi 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"
  }
}

Přehled

Veďte blog obchodu s články v HTML, fotografiemi, autory a metadaty pro vyhledávače. Ukládejte koncepty, připravujte překlady a publikujte ihned nebo ve zvolený čas a časové pásmo. Komentáře a moderaci spravujte v panelu; externí generátor může využít API s přidělenými oprávněními.

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

Parametry

Parametry dotazu

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

minLength: 2maxLength: 35
Omezení
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Příklad: "pl"
limitCelé čísloVolitelné

Maximální počet záznamů na této stránce.

minimum: 1maximum: 100
Výchozí hodnota: 50Příklad: 10
cursorŘetězec nullVolitelné

Neprůhledná hodnota pro pokračování vrácená předchozí stránkou.

Řetězec:maxLength: 512
statusŘetězec nullVolitelné

Stav přijímaný touto konkrétní operací.

Omezení · Řetězec 1
enum
["draft", "scheduled", "published", "archived"]
Příklad: "draft"
titleŘetězec nullVolitelné

Název ve vybraném jazyce.

Řetězec:maxLength: 200
author_idŘetězec nullVolitelné

Autor

Řetězec:format: "uuid"
publish_fromŘetězec nullVolitelné

Publikováno od

Řetězec:format: "date-time"
publish_toŘetězec nullVolitelné

Publikováno před

Řetězec:format: "date-time"

Tato operace nepřijímá tělo JSON.

Odpovědi

Odpověď 200

dataPole <ObjektDalší pole: Ne> Povinné

Obsah úspěšné odpovědi.

maxItems: 100
Pole · data

ObjektDalší pole: Ne

author_nameŘetězecPovinné

Autor

maxLength: 160
cover_altŘetězecPovinné

Alternativní text

maxLength: 250
cover_media_idŘetězec nullPovinné

Úvodní fotografie

Řetězec:format: "uuid"
first_published_atŘetězec nullPovinné

První publikování

Řetězec:format: "date-time"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

format: "uuid"
public_numberCelé čísloPovinné

Číslo

minimum: 1
publish_atŘetězec nullPovinné

Datum publikování

Řetězec:format: "date-time"
statusŘetězecPovinné

Stav přijímaný touto konkrétní operací.

Omezení
enum
["draft", "scheduled", "published", "archived"]
titleŘetězecPovinné

Název ve vybraném jazyce.

maxLength: 200
updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

minimum: 1maximum: 9223372036854775807
metaObjektDalší pole: NePovinné

Metadata odpovědi.

Pole · meta
paginationObjektDalší pole: NePovinné

Metadata stránkování pomocí kurzoru.

Pole · pagination
has_moreLogická hodnotaPovinné

Zda je dostupná další stránka.

limitCelé čísloPovinné

Maximální počet záznamů na této stránce.

minimum: 1maximum: 100
next_cursorŘetězec nullPovinné

Hodnota pro pokračování na další stránku, nebo null.

Řetězec:maxLength: 512
request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0