Preskočiť na obsah
ShopentlyLearn

Zobraziť zoznam · Články

Čítať články a zobrazovať náhľady konceptov

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

Overovanie
Bearer
Dostupné od plánu
BASIC
Vyžadovaný nainštalovaný modul
shopently.blog · Verzia kontraktu modulu 1
Požadované oprávnenia
addon.shopently.blog:post_read

Príklady kódu

Príklad požiadavky

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

Príklad odpovede 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"
  }
}

Prehľad

Veďte blog obchodu s HTML článkami, fotografiami, autormi a metadátami pre vyhľadávače. Ukladajte koncepty, pripravujte preklady a publikujte ihneď alebo vo vybranom čase a časovom pásme. Komentáre a moderovanie spravujte v paneli; externý generátor môže využívať API s pridelenými oprávneniami.

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

Parametre

Parametre dopytu

localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

minLength: 2maxLength: 35
Obmedzenia
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Príklad: "pl"
limitCelé čísloVoliteľné

Maximálny počet záznamov na tejto stránke.

minimum: 1maximum: 100
Predvolená hodnota: 50Príklad: 10
cursorReťazec nullVoliteľné

Nepriehľadná hodnota na pokračovanie vrátená predchádzajúcou stránkou.

Reťazec:maxLength: 512
statusReťazec nullVoliteľné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia · Reťazec 1
enum
["draft", "scheduled", "published", "archived"]
Príklad: "draft"
titleReťazec nullVoliteľné

Názov vo vybranom jazyku.

Reťazec:maxLength: 200
author_idReťazec nullVoliteľné

Autor

Reťazec:format: "uuid"
publish_fromReťazec nullVoliteľné

Publikované od

Reťazec:format: "date-time"
publish_toReťazec nullVoliteľné

Publikované pred

Reťazec:format: "date-time"

Táto operácia neprijíma telo JSON.

Odpovede

Odpoveď 200

dataPole <ObjektĎalšie polia: Nie> Povinné

Obsah úspešnej odpovede.

maxItems: 100
Polia · data

ObjektĎalšie polia: Nie

author_nameReťazecPovinné

Autor

maxLength: 160
cover_altReťazecPovinné

Alternatívny text

maxLength: 250
cover_media_idReťazec nullPovinné

Úvodná fotografia

Reťazec:format: "uuid"
first_published_atReťazec nullPovinné

Prvé publikovanie

Reťazec:format: "date-time"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

format: "uuid"
public_numberCelé čísloPovinné

Číslo

minimum: 1
publish_atReťazec nullPovinné

Dátum publikovania

Reťazec:format: "date-time"
statusReťazecPovinné

Stav prijímaný touto konkrétnou operáciou.

Obmedzenia
enum
["draft", "scheduled", "published", "archived"]
titleReťazecPovinné

Názov vo vybranom jazyku.

maxLength: 200
updated_atReťazecPovinné

Čas poslednej aktualizácie.

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

Verzia zdroja používaná na riadenie súbežných zmien.

minimum: 1maximum: 9223372036854775807
metaObjektĎalšie polia: NiePovinné

Metaúdaje odpovede.

Polia · meta
paginationObjektĎalšie polia: NiePovinné

Metaúdaje stránkovania pomocou kurzora.

Polia · pagination
has_moreLogická hodnotaPovinné

Či je dostupná ďalšia stránka.

limitCelé čísloPovinné

Maximálny počet záznamov na tejto stránke.

minimum: 1maximum: 100
next_cursorReťazec nullPovinné

Hodnota na pokračovanie na ďalšiu stránku alebo null.

Reťazec:maxLength: 512
request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100
Príklad odpovede

Stav HTTP

200
Úspešná odpoveď Schéma
400
Neplatná požiadavka
401
Vyžaduje sa overenie
403
Prístup zamietnutý
404
Zdroj sa nenašiel
409
Konflikt verzií
422
Chyba validácie
429
Prekročený limit požiadaviek
Ďalšie stavy HTTP (7)
405
Metóda nie je povolená
413
Príliš veľká požiadavka
415
Nepodporovaný formát
500
Chyba servera
502
Chyba brány API
503
Služba nedostupná
504
Vypršal časový limit

Katalóg chýb: ErrorResponse

Hlavičky

401

WWW-AuthenticateReťazecVoliteľné

Spôsob overenia požadovaný serverom.

405

AllowReťazecVoliteľné

Metódy HTTP podporované týmto zdrojom.

429, 503

Retry-AfterCelé čísloVoliteľné

Minimálne oneskorenie pred opakovaním v sekundách.

minimum: 0