Przejdź do treści
ShopentlyLearn

Pobierz listę · Artykuły

Odczyt artykułów i podgląd szkiców

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

Uwierzytelnianie
Bearer
Dostępne od planu
BASIC
Wymagany zainstalowany moduł
shopently.blog · Wersja kontraktu modułu 1
Wymagane uprawnienia
addon.shopently.blog:post_read

Przykłady kodu

Przykład żądania

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

Przykład odpowiedzi 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"
  }
}

Przegląd

Prowadź blog sklepu z artykułami HTML, zdjęciami, autorami i metadanymi dla wyszukiwarek. Zapisuj szkice, przygotowuj wersje językowe i publikuj od razu lub o wybranej porze w danej strefie czasowej. Zarządzaj komentarzami i moderacją w panelu; zewnętrzny generator może korzystać z API z przyznanymi uprawnieniami.

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

Parametry

Parametry zapytania

localeTekstWymagane

Język wybrany dla tego żądania.

minLength: 2maxLength: 35
Ograniczenia
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Przykład: "pl"
limitLiczba całkowitaOpcjonalne

Maksymalna liczba rekordów na tej stronie.

minimum: 1maximum: 100
Wartość domyślna: 50Przykład: 10
cursorTekst nullOpcjonalne

Nieinterpretowany znacznik kontynuacji zwrócony na poprzedniej stronie.

Tekst:maxLength: 512
statusTekst nullOpcjonalne

Status obsługiwany przez daną operację.

Ograniczenia · Tekst 1
enum
["draft", "scheduled", "published", "archived"]
Przykład: "draft"
titleTekst nullOpcjonalne

Tytuł w wybranym języku.

Tekst:maxLength: 200
author_idTekst nullOpcjonalne

Autor

Tekst:format: "uuid"
publish_fromTekst nullOpcjonalne

Publikacja od

Tekst:format: "date-time"
publish_toTekst nullOpcjonalne

Publikacja przed

Tekst:format: "date-time"

Ta operacja nie przyjmuje treści JSON.

Odpowiedzi

Odpowiedź 200

dataTablica <ObiektDodatkowe pola: Nie> Wymagane

Dane poprawnej odpowiedzi.

maxItems: 100
Pola · data

ObiektDodatkowe pola: Nie

author_nameTekstWymagane

Autor

maxLength: 160
cover_altTekstWymagane

Tekst alternatywny

maxLength: 250
cover_media_idTekst nullWymagane

Zdjęcie główne

Tekst:format: "uuid"
first_published_atTekst nullWymagane

Pierwsza publikacja

Tekst:format: "date-time"
idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

format: "uuid"
public_numberLiczba całkowitaWymagane

Numer

minimum: 1
publish_atTekst nullWymagane

Termin publikacji

Tekst:format: "date-time"
statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia
enum
["draft", "scheduled", "published", "archived"]
titleTekstWymagane

Tytuł w wybranym języku.

maxLength: 200
updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

minimum: 1maximum: 9223372036854775807
metaObiektDodatkowe pola: NieWymagane

Metadane odpowiedzi.

Pola · meta
paginationObiektDodatkowe pola: NieWymagane

Metadane stronicowania z użyciem kursora.

Pola · pagination
has_moreWartość logicznaWymagane

Czy dostępna jest kolejna strona.

limitLiczba całkowitaWymagane

Maksymalna liczba rekordów na tej stronie.

minimum: 1maximum: 100
next_cursorTekst nullWymagane

Znacznik kontynuacji dla następnej strony albo null.

Tekst:maxLength: 512
request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

200
Poprawna odpowiedź Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0