İçeriğe atla
ShopentlyLearn

Listele · Makaleler

Makaleleri okuma ve taslakları önizleme

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

Kimlik doğrulama
Bearer
En düşük plan
BASIC
Gerekli kurulu modül
shopently.blog · Modül sözleşme sürümü 1
Gerekli izinler
addon.shopently.blog:post_read

Kod örnekleri

İstek örneği

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

Yanıt örneği 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"
  }
}

Genel bakış

Mağazanızın blogunu HTML makaleler, fotoğraflar, yazarlar ve arama motoru meta verileriyle yönetin. Taslakları kaydedin, çevirileri hazırlayın ve hemen ya da belirli bir saat diliminde seçtiğiniz zamanda yayımlayın. Yorumları ve denetimi panelden yönetin; harici bir üretici, verdiğiniz izinlerle API’yi kullanabilir.

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

Parametreler

Sorgu parametreleri

localeDizeZorunlu

Bu istek için seçilen dil.

minLength: 2maxLength: 35
Kısıtlamalar
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Örnek: "pl"
limitTam sayıİsteğe bağlı

Bu sayfadaki en yüksek kayıt sayısı.

minimum: 1maximum: 100
Varsayılan: 50Örnek: 10
cursorDize nullİsteğe bağlı

Önceki sayfanın döndürdüğü, iç yapısı yorumlanmaması gereken devam değeri.

Dize:maxLength: 512
statusDize nullİsteğe bağlı

Bu işlemin kabul ettiği durum.

Kısıtlamalar · Dize 1
enum
["draft", "scheduled", "published", "archived"]
Örnek: "draft"
titleDize nullİsteğe bağlı

Seçilen dilde başlık.

Dize:maxLength: 200
author_idDize nullİsteğe bağlı

Yazar

Dize:format: "uuid"
publish_fromDize nullİsteğe bağlı

Bu tarihten itibaren yayımlanan

Dize:format: "date-time"
publish_toDize nullİsteğe bağlı

Bu tarihten önce yayımlanan

Dize:format: "date-time"

Bu işlem JSON gövdesi kabul etmez.

Yanıtlar

Yanıt 200

dataDizi <NesneEk alanlar: Hayır> Zorunlu

Başarılı yanıtın verileri.

maxItems: 100
Alanlar · data

NesneEk alanlar: Hayır

author_nameDizeZorunlu

Yazar

maxLength: 160
cover_altDizeZorunlu

Alternatif metin

maxLength: 250
cover_media_idDize nullZorunlu

Kapak fotoğrafı

Dize:format: "uuid"
first_published_atDize nullZorunlu

İlk yayın

Dize:format: "date-time"
idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.

format: "uuid"
public_numberTam sayıZorunlu

Numara

minimum: 1
publish_atDize nullZorunlu

Yayın tarihi

Dize:format: "date-time"
statusDizeZorunlu

Bu işlemin kabul ettiği durum.

Kısıtlamalar
enum
["draft", "scheduled", "published", "archived"]
titleDizeZorunlu

Seçilen dilde başlık.

maxLength: 200
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

minimum: 1maximum: 9223372036854775807
metaNesneEk alanlar: HayırZorunlu

Yanıt üst verileri.

Alanlar · meta
paginationNesneEk alanlar: HayırZorunlu

İmleç tabanlı sayfalamanın üst verileri.

Alanlar · pagination
has_moreMantıksal değerZorunlu

Başka bir sayfanın mevcut olup olmadığı.

limitTam sayıZorunlu

Bu sayfadaki en yüksek kayıt sayısı.

minimum: 1maximum: 100
next_cursorDize nullZorunlu

Sonraki sayfanın devam değeri veya null.

Dize:maxLength: 512
request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100
Yanıt örneği

HTTP durumu

200
Başarılı yanıt Şema
400
Geçersiz istek
401
Kimlik doğrulaması gerekli
403
İzin reddedildi
404
Kaynak bulunamadı
409
Sürüm çakışması
422
Doğrulama başarısız
429
İstek sınırı aşıldı
Diğer HTTP durumları (7)
405
Yönteme izin verilmiyor
413
İstek çok büyük
415
Desteklenmeyen biçim
500
Sunucu hatası
502
API ağ geçidi hatası
503
Hizmet kullanılamıyor
504
Zaman aşımı

Hata kataloğu: ErrorResponse

Başlıklar

401

WWW-AuthenticateDizeİsteğe bağlı

Sunucunun gerektirdiği kimlik doğrulama şeması.

405

AllowDizeİsteğe bağlı

Bu kaynağın desteklediği HTTP yöntemleri.

429, 503

Retry-AfterTam sayıİsteğe bağlı

Yeniden denemeden önce saniye cinsinden en kısa bekleme süresi.

minimum: 0