Aller au contenu
ShopentlyLearn

Lister · Articles

Lire les articles et prévisualiser les brouillons

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

Authentification
Bearer
Disponible à partir de
BASIC
Module installé requis
shopently.blog · Version du contrat du module 1
Autorisations requises
addon.shopently.blog:post_read

Exemples de code

Exemple de requête

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

Exemple de réponse 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"
  }
}

Vue d’ensemble

Animez le blog de votre boutique avec des articles HTML, des photos, des auteurs et des métadonnées pour les moteurs de recherche. Enregistrez des brouillons, préparez des traductions et publiez immédiatement ou à une heure choisie dans un fuseau précis. Gérez les commentaires et leur modération dans le panneau ; un générateur externe peut utiliser l’API avec les autorisations accordées.

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

Paramètres

Paramètres de requête

localeChaîneObligatoire

Langue sélectionnée pour cette requête.

minLength: 2maxLength: 35
Contraintes
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
Exemple: "pl"
limitEntierFacultatif

Nombre maximal d'enregistrements sur cette page.

minimum: 1maximum: 100
Valeur par défaut: 50Exemple: 10
cursorChaîne nullFacultatif

Valeur opaque de continuation renvoyée par la page précédente.

Chaîne:maxLength: 512
statusChaîne nullFacultatif

Statut accepté par cette opération précise.

Contraintes · Chaîne 1
enum
["draft", "scheduled", "published", "archived"]
Exemple: "draft"
titleChaîne nullFacultatif

Titre dans la langue sélectionnée.

Chaîne:maxLength: 200
author_idChaîne nullFacultatif

Auteur

Chaîne:format: "uuid"
publish_fromChaîne nullFacultatif

Publié à partir du

Chaîne:format: "date-time"
publish_toChaîne nullFacultatif

Publié avant le

Chaîne:format: "date-time"

Cette opération n'accepte pas de corps JSON.

Réponses

Réponse 200

dataTableau <ObjetChamps supplémentaires: Non> Obligatoire

Données d'une réponse réussie.

maxItems: 100
Champs · data

ObjetChamps supplémentaires: Non

author_nameChaîneObligatoire

Auteur

maxLength: 160
cover_altChaîneObligatoire

Texte alternatif

maxLength: 250
cover_media_idChaîne nullObligatoire

Photo de couverture

Chaîne:format: "uuid"
first_published_atChaîne nullObligatoire

Première publication

Chaîne:format: "date-time"
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"
public_numberEntierObligatoire

Numéro

minimum: 1
publish_atChaîne nullObligatoire

Date de publication

Chaîne:format: "date-time"
statusChaîneObligatoire

Statut accepté par cette opération précise.

Contraintes
enum
["draft", "scheduled", "published", "archived"]
titleChaîneObligatoire

Titre dans la langue sélectionnée.

maxLength: 200
updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"
versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

minimum: 1maximum: 9223372036854775807
metaObjetChamps supplémentaires: NonObligatoire

Métadonnées de la réponse.

Champs · meta
paginationObjetChamps supplémentaires: NonObligatoire

Métadonnées de pagination par curseur.

Champs · pagination
has_moreBooléenObligatoire

Indique si une page supplémentaire est disponible.

limitEntierObligatoire

Nombre maximal d'enregistrements sur cette page.

minimum: 1maximum: 100
next_cursorChaîne nullObligatoire

Valeur de continuation pour la page suivante, ou null.

Chaîne:maxLength: 512
request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100
Exemple de réponse

Statut HTTP

200
Réponse réussie Schéma
400
Requête invalide
401
Authentification requise
403
Accès refusé
404
Ressource introuvable
409
Conflit de version
422
Échec de validation
429
Limite de requêtes dépassée
Autres statuts HTTP (7)
405
Méthode non autorisée
413
Requête trop volumineuse
415
Format non pris en charge
500
Erreur du serveur
502
Erreur de passerelle API
503
Service indisponible
504
Délai de passerelle dépassé

Catalogue des erreurs: ErrorResponse

En-têtes

401

WWW-AuthenticateChaîneFacultatif

Schéma d'authentification exigé par le serveur.

405

AllowChaîneFacultatif

Méthodes HTTP prises en charge par cette ressource.

429, 503

Retry-AfterEntierFacultatif

Délai minimal avant une nouvelle tentative, en secondes.

minimum: 0