Pereiti prie turinio
ShopentlyLearn

Sąrašas · Straipsniai

Skaityti straipsnius ir peržiūrėti juodraščius

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

Tapatybės patvirtinimas
Bearer
Prieinama nuo plano
BASIC
Būtinas įdiegtas modulis
shopently.blog · Modulio sutarties versija 1
Būtinos teisės
addon.shopently.blog:post_read

Kodo pavyzdžiai

Užklausos pavyzdys

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

Atsakymo pavyzdys 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"
  }
}

Apžvalga

Tvarkykite parduotuvės tinklaraštį su HTML straipsniais, nuotraukomis, autoriais ir paieškos sistemų metaduomenimis. Saugokite juodraščius, ruoškite vertimus ir publikuokite iš karto arba pasirinktu laiku konkrečioje laiko juostoje. Valdykite komentarus ir moderavimą skydelyje; išorinis generatorius gali naudoti API su suteiktomis teisėmis.

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

Parametrai

Užklausos parametrai

localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

minLength: 2maxLength: 35
Apribojimai
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Pavyzdys: "pl"
limitSveikasis skaičiusNeprivalomas

Didžiausias įrašų skaičius šiame puslapyje.

minimum: 1maximum: 100
Numatytoji reikšmė: 50Pavyzdys: 10
cursorEilutė nullNeprivalomas

Ankstesnio puslapio grąžinta tęsimo reikšmė; jos vidinės struktūros neinterpretuokite.

Eilutė:maxLength: 512
statusEilutė nullNeprivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai · Eilutė 1
enum
["draft", "scheduled", "published", "archived"]
Pavyzdys: "draft"
titleEilutė nullNeprivalomas

Pavadinimas pasirinkta kalba.

Eilutė:maxLength: 200
author_idEilutė nullNeprivalomas

Autorius

Eilutė:format: "uuid"
publish_fromEilutė nullNeprivalomas

Paskelbta nuo

Eilutė:format: "date-time"
publish_toEilutė nullNeprivalomas

Paskelbta iki

Eilutė:format: "date-time"

Ši operacija nepriima JSON turinio.

Atsakymai

Atsakymas 200

dataMasyvas <ObjektasPapildomi laukai: Ne> Privalomas

Sėkmingo atsakymo duomenys.

maxItems: 100
Laukai · data

ObjektasPapildomi laukai: Ne

author_nameEilutėPrivalomas

Autorius

maxLength: 160
cover_altEilutėPrivalomas

Alternatyvusis tekstas

maxLength: 250
cover_media_idEilutė nullPrivalomas

Viršelio nuotrauka

Eilutė:format: "uuid"
first_published_atEilutė nullPrivalomas

Pirmą kartą paskelbta

Eilutė:format: "date-time"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

format: "uuid"
public_numberSveikasis skaičiusPrivalomas

Numeris

minimum: 1
publish_atEilutė nullPrivalomas

Publikavimo data

Eilutė:format: "date-time"
statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai
enum
["draft", "scheduled", "published", "archived"]
titleEilutėPrivalomas

Pavadinimas pasirinkta kalba.

maxLength: 200
updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

minimum: 1maximum: 9223372036854775807
metaObjektasPapildomi laukai: NePrivalomas

Atsakymo metaduomenys.

Laukai · meta
paginationObjektasPapildomi laukai: NePrivalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

Laukai · pagination
has_moreLoginė reikšmėPrivalomas

Ar yra kitas puslapis.

limitSveikasis skaičiusPrivalomas

Didžiausias įrašų skaičius šiame puslapyje.

minimum: 1maximum: 100
next_cursorEilutė nullPrivalomas

Kito puslapio tęsimo reikšmė arba null.

Eilutė:maxLength: 512
request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Atsakymo pavyzdys

HTTP būsena

200
Sėkmingas atsakymas Schema
400
Netinkama užklausa
401
Būtinas tapatybės patvirtinimas
403
Prieiga uždrausta
404
Išteklius nerastas
409
Versijų konfliktas
422
Tikrinimo klaida
429
Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405
Metodas neleidžiamas
413
Užklausa per didelė
415
Nepalaikomas formatas
500
Serverio klaida
502
API tinklų sietuvo klaida
503
Paslauga nepasiekiama
504
Baigėsi laukimo laikas

Klaidų katalogas: ErrorResponse

Antraštės

401

WWW-AuthenticateEilutėNeprivalomas

Serverio reikalaujama tapatybės patvirtinimo schema.

405

AllowEilutėNeprivalomas

Šio ištekliaus palaikomi HTTP metodai.

429, 503

Retry-AfterSveikasis skaičiusNeprivalomas

Mažiausias laukimo laikas prieš kartojant, sekundėmis.

minimum: 0