Gå til indhold
ShopentlyLearn

Vis liste · Artikler

Læs artikler og forhåndsvis kladder

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

Godkendelse
Bearer
Tilgængelig fra
BASIC
Påkrævet installeret modul
shopently.blog · Modulets kontraktversion 1
Nødvendige rettigheder
addon.shopently.blog:post_read

Kodeeksempler

Eksempel på forespørgsel

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

Eksempel på svar 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"
  }
}

Oversigt

Driv butikkens blog med HTML-artikler, fotos, forfattere og metadata til søgemaskiner. Gem kladder, klargør oversættelser, og udgiv straks eller på et valgt tidspunkt i en bestemt tidszone. Administrer kommentarer og moderation i panelet; en ekstern generator kan bruge API’et med de rettigheder, du tildeler.

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

Parametre

Forespørgselsparametre

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

minLength: 2maxLength: 35
Begrænsninger
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Eksempel: "pl"
limitHeltalValgfrit

Maksimalt antal poster på denne side.

minimum: 1maximum: 100
Standard: 50Eksempel: 10
cursorStreng nullValgfrit

Uigennemsigtig fortsættelsesværdi returneret af den foregående side.

Streng:maxLength: 512
statusStreng nullValgfrit

Status accepteret af denne specifikke operation.

Begrænsninger · Streng 1
enum
["draft", "scheduled", "published", "archived"]
Eksempel: "draft"
titleStreng nullValgfrit

Titel på det valgte sprog.

Streng:maxLength: 200
author_idStreng nullValgfrit

Forfatter

Streng:format: "uuid"
publish_fromStreng nullValgfrit

Udgivet fra

Streng:format: "date-time"
publish_toStreng nullValgfrit

Udgivet før

Streng:format: "date-time"

Denne operation accepterer ikke JSON-indhold.

Svar

Svar 200

dataArray <ObjektYderligere felter: Nej> Obligatorisk

Indholdet af et vellykket svar.

maxItems: 100
Felter · data

ObjektYderligere felter: Nej

author_nameStrengObligatorisk

Forfatter

maxLength: 160
cover_altStrengObligatorisk

Alternativ tekst

maxLength: 250
cover_media_idStreng nullObligatorisk

Forsidefoto

Streng:format: "uuid"
first_published_atStreng nullObligatorisk

Først udgivet

Streng:format: "date-time"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

format: "uuid"
public_numberHeltalObligatorisk

Nummer

minimum: 1
publish_atStreng nullObligatorisk

Udgivelsesdato

Streng:format: "date-time"
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["draft", "scheduled", "published", "archived"]
titleStrengObligatorisk

Titel på det valgte sprog.

maxLength: 200
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

minimum: 1maximum: 9223372036854775807
metaObjektYderligere felter: NejObligatorisk

Svarmetadata.

Felter · meta
paginationObjektYderligere felter: NejObligatorisk

Metadata for markørbaseret sideinddeling.

Felter · pagination
has_moreBoolesk værdiObligatorisk

Om der findes endnu en side.

limitHeltalObligatorisk

Maksimalt antal poster på denne side.

minimum: 1maximum: 100
next_cursorStreng nullObligatorisk

Fortsættelsesværdi for næste side eller null.

Streng:maxLength: 512
request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0