Mine sisu juurde
ShopentlyLearn

Loend · Artiklid

Artiklite lugemine ja mustandite eelvaade

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

Autentimine
Bearer
Saadaval alates
BASIC
Nõutav paigaldatud moodul
shopently.blog · Mooduli lepinguversioon 1
Nõutavad õigused
addon.shopently.blog:post_read

Koodinäited

Päringu näide

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

Vastuse näide 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"
  }
}

Ülevaade

Pea poe blogi HTML-artiklite, fotode, autorite ja otsingumootorite metaandmetega. Salvesta mustandeid, valmista ette tõlkeid ning avalda kohe või valitud ajal kindlas ajavööndis. Halda kommentaare ja modereerimist juhtpaneelis; väline generaator saab kasutada API-t sinu antud õigustega.

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

Parameetrid

Päringu parameetrid

localeStringKohustuslik

Selle päringu jaoks valitud keel.

minLength: 2maxLength: 35
Piirangud
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Näide: "pl"
limitTäisarvValikuline

Kirjete maksimaalne arv sellel lehel.

minimum: 1maximum: 100
Vaikeväärtus: 50Näide: 10
cursorString nullValikuline

Eelmisel lehel tagastatud läbipaistmatu jätkuväärtus.

String:maxLength: 512
statusString nullValikuline

Selle konkreetse toimingu lubatud olek.

Piirangud · String 1
enum
["draft", "scheduled", "published", "archived"]
Näide: "draft"
titleString nullValikuline

Pealkiri valitud keeles.

String:maxLength: 200
author_idString nullValikuline

Autor

String:format: "uuid"
publish_fromString nullValikuline

Avaldatud alates

String:format: "date-time"
publish_toString nullValikuline

Avaldatud enne

String:format: "date-time"

See toiming ei võta vastu JSON-sisu.

Vastused

Vastus 200

dataMassiiv <ObjektLisaväljad: Ei> Kohustuslik

Eduka vastuse andmed.

maxItems: 100
Väljad · data

ObjektLisaväljad: Ei

author_nameStringKohustuslik

Autor

maxLength: 160
cover_altStringKohustuslik

Alternatiivtekst

maxLength: 250
cover_media_idString nullKohustuslik

Kaanefoto

String:format: "uuid"
first_published_atString nullKohustuslik

Esmakordselt avaldatud

String:format: "date-time"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

format: "uuid"
public_numberTäisarvKohustuslik

Number

minimum: 1
publish_atString nullKohustuslik

Avaldamiskuupäev

String:format: "date-time"
statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud
enum
["draft", "scheduled", "published", "archived"]
titleStringKohustuslik

Pealkiri valitud keeles.

maxLength: 200
updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

minimum: 1maximum: 9223372036854775807
metaObjektLisaväljad: EiKohustuslik

Vastuse metaandmed.

Väljad · meta
paginationObjektLisaväljad: EiKohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

Väljad · pagination
has_moreTõeväärtusKohustuslik

Kas järgmine leht on saadaval.

limitTäisarvKohustuslik

Kirjete maksimaalne arv sellel lehel.

minimum: 1maximum: 100
next_cursorString nullKohustuslik

Järgmise lehe jätkuväärtus või null.

String:maxLength: 512
request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Vastuse näide

HTTP-olek

200
Edukas vastus Skeem
400
Vigane päring
401
Autentimine on nõutav
403
Juurdepääs keelatud
404
Ressurssi ei leitud
409
Versioonikonflikt
422
Valideerimine nurjus
429
Päringupiirang ületatud
Muud HTTP olekud (7)
405
Meetod pole lubatud
413
Päring on liiga suur
415
Vormingut ei toetata
500
Serveri viga
502
API lüüsi viga
503
Teenus pole saadaval
504
Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

401

WWW-AuthenticateStringValikuline

Serveri nõutav autentimisskeem.

405

AllowStringValikuline

Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline

Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0