Preskoči na sadržaj
ShopentlyLearn

Članak

Čitanje članaka i pregled nacrta

GET/api/v1/addons/shopently.blog/posts/{post_id}

Autentifikacija
Bearer
Dostupno od
BASIC
Potreban instalirani modul
shopently.blog · Verzija ugovora modula 1
Potrebne ovlasti
addon.shopently.blog:post_read

Primjeri koda

Primjer zahtjeva

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/2103ba96-2713-420b-b197-8a008730c851?locale=pl'

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/2103ba96-2713-420b-b197-8a008730c851?locale=pl');
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/2103ba96-2713-420b-b197-8a008730c851?locale=pl', 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))

Primjer odgovora 200

JSON
{
  "data": {
    "author_id": "341494e0-caab-4f47-a8ff-f6795c42a775",
    "comments_mode": "open",
    "content_html": "<h2>Porównaj właściwości</h2><p>Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.</p>",
    "cover_alt": "Niebieska ilustracja poradnika",
    "cover_caption": "Ilustracja redakcyjna",
    "cover_media_id": "e8663afe-3c38-461c-a142-a980085630af",
    "draft_revision_id": "8c4af6da-63f4-42aa-8b37-57c703fa0af7",
    "excerpt": "Praktyczny poradnik zakupowy.",
    "first_published_at": null,
    "id": "2103ba96-2713-420b-b197-8a008730c851",
    "last_published_at": null,
    "locale": "pl",
    "meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.",
    "meta_keywords": [
      "poradnik",
      "wybór"
    ],
    "meta_title": "Jak wybrać produkt",
    "public_number": 1,
    "publish_at": null,
    "publish_timezone": null,
    "published_revision_id": null,
    "schedule_state": null,
    "scheduled_revision_id": null,
    "slug": "jak-wybrac-produkt",
    "status": "draft",
    "title": "Jak wybrać produkt",
    "updated_at": "2026-10-07T23:17:44.320869Z",
    "version": 1
  },
  "meta": {
    "request_id": "c85f6074-44e5-4d74-a117-fb631879fb7d"
  }
}

Pregled

Vodite blog trgovine s HTML člancima, fotografijama, autorima i metapodacima za tražilice. Spremajte nacrte, pripremajte prijevode i objavljujte odmah ili u odabrano vrijeme i vremensku zonu. Upravljajte komentarima i moderiranjem u panelu; vanjski generator može koristiti API s dodijeljenim ovlastima.

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

Parametri

Parametri putanje

post_idNiz znakovaObvezno

Članak

format: "uuid"
Primjer: "2103ba96-2713-420b-b197-8a008730c851"

Parametri upita

localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

minLength: 2maxLength: 35
Ograničenja
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Primjer: "pl"

Ova operacija ne prihvaća JSON tijelo.

Odgovori

Odgovor 200

dataObjektDodatna polja: NeObvezno

Podaci uspješnog odgovora.

Polja · data
author_idNiz znakova nullObvezno

Autor

Niz znakova:format: "uuid"
comments_modeNiz znakovaObvezno

Komentari

Ograničenja
enum
["inherit", "open", "closed"]
content_htmlNiz znakovaObvezno

Sadržaj

maxLength: 50000
cover_altNiz znakovaObvezno

Alternativni tekst

maxLength: 250
cover_captionNiz znakovaObvezno

Opis fotografije

maxLength: 500
cover_media_idNiz znakova nullObvezno

Naslovna fotografija

Niz znakova:format: "uuid"
draft_revision_idNiz znakovaObvezno

Verzija nacrta

format: "uuid"
excerptNiz znakovaObvezno

Uvod

maxLength: 1000
first_published_atNiz znakova nullObvezno

Prvi put objavljeno

Niz znakova:format: "date-time"
idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

format: "uuid"
last_published_atNiz znakova nullObvezno

Zadnji put objavljeno

Niz znakova:format: "date-time"
localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

minLength: 2maxLength: 35
Ograničenja
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionNiz znakovaObvezno

Opis za tražilice na odabranom jeziku.

maxLength: 160
meta_keywordsPolje vrijednosti <Niz znakova> Obvezno

Ključne riječi za tražilice na odabranom jeziku.

maxItems: 20
Polje vrijednosti:minLength: 1maxLength: 50
meta_titleNiz znakovaObvezno

Naslov za tražilice na odabranom jeziku.

maxLength: 70
public_numberCijeli brojObvezno

Broj

minimum: 1
publish_atNiz znakova nullObvezno

Datum objave

Niz znakova:format: "date-time"
publish_timezoneNiz znakova nullObvezno

Vremenska zona

Niz znakova:maxLength: 64
published_revision_idNiz znakova nullObvezno

Verzija (Objavljeno)

Niz znakova:format: "uuid"
schedule_stateNiz znakova nullObvezno

Zakazana objava

Ograničenja · Niz znakova 1
enum
["armed", "requires_confirmation"]
scheduled_revision_idNiz znakova nullObvezno

Verzija (Zakazano)

Niz znakova:format: "uuid"
slugNiz znakovaObvezno

Dio URL putanje na odabranom jeziku.

maxLength: 160
statusNiz znakovaObvezno

Status prihvaćen za ovu određenu operaciju.

Ograničenja
enum
["draft", "scheduled", "published", "archived"]
titleNiz znakovaObvezno

Naslov na odabranom jeziku.

maxLength: 200
updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"
versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

minimum: 1maximum: 9223372036854775807
metaObjektDodatna polja: NeObvezno

Metapodaci odgovora.

Polja · meta
request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

minLength: 1maxLength: 100
Primjer odgovora

HTTP status

200
Uspješan odgovor Shema
400
Nevaljan zahtjev
401
Potrebna je autentikacija
403
Pristup odbijen
404
Resurs nije pronađen
409
Sukob verzija
422
Provjera nije uspjela
429
Prekoračeno ograničenje zahtjeva
Ostali HTTP statusi (7)
405
Metoda nije dopuštena
413
Zahtjev je prevelik
415
Nepodržan format
500
Pogreška poslužitelja
502
Pogreška API pristupnika
503
Usluga nije dostupna
504
Istek vremena

Katalog pogrešaka: ErrorResponse

Zaglavlja

401

WWW-AuthenticateNiz znakovaNeobavezno

Shema autentifikacije koju zahtijeva poslužitelj.

405

AllowNiz znakovaNeobavezno

HTTP metode koje ovaj resurs podržava.

429, 503

Retry-AfterCijeli brojNeobavezno

Najkraće čekanje prije ponavljanja, u sekundama.

minimum: 0