Vai al contenuto
ShopentlyLearn

Recupera — Pagine CMS

Leggi i dati di «Pagine CMS». Il risultato dipende dai parametri di questa operazione.

GET/api/v1/pages/{page_id}

Autenticazione
Bearer
Disponibile dal piano
STANDARD
Permessi necessari
content.page:read

Esempi di codice

Esempio di richiesta

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/pages/example

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/pages/example');
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/pages/example', 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))

Esempio di risposta 200

JSON
{
  "data": {
    "body_html": "<p>Example</p>",
    "created_at": "2026-01-01T12:00:00Z",
    "id": "example",
    "is_available": true,
    "market_scope": "all",
    "meta_description": "example",
    "meta_keywords": [
      "example"
    ],
    "meta_title": "example",
    "number": "example",
    "published": false,
    "slug": "example",
    "title": "example",
    "updated_at": "2026-01-01T12:00:00Z",
    "version": 1
  },
  "meta": {
    "locale": "en",
    "market_code": "PL",
    "market_id": "example",
    "request_id": "example"
  }
}

Principi

  • Le scritture sulle pagine comprendono titolo, slug, contenuto HTML, metadati SEO, stato di pubblicazione e ambito dei mercati supportato.
  • Scegli esplicitamente la lingua quando gestisci contenuti tradotti.
  • PATCH modifica soltanto i campi inviati.
  • null è ammesso solo quando schema e contesto consentono di cancellare il valore.
  • Restano valide le regole esistenti di pubblicazione, validazione dei contenuti e piano.

Parametri

Parametri del percorso

page_idStringaObbligatorio

Identificativo della pagina CMS.

Vincoli
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Esempio: "example"

Parametri di query

localeStringa nullFacoltativo

Lingua selezionata per questa richiesta.

Stringa:minLength: 2maxLength: 20
market_idStringa nullFacoltativo

Identificativo del mercato restituito dall’endpoint del contesto.

Vincoli · Stringa 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStringa nullFacoltativo

Codice del mercato restituito dall’endpoint del contesto.

Stringa:minLength: 1maxLength: 16

Questa operazione non accetta un corpo JSON.

Risposte

Risposta 200

dataPageDetailData Obbligatorio

Contenuto di una risposta riuscita.

Campi · data
body_htmlStringa nullObbligatorio

Contenuto della pagina in HTML.

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

market_scopeStringaObbligatorio

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli
enum
["all", "selected"]
meta_descriptionStringa nullObbligatorio

Descrizione per i motori di ricerca nella lingua selezionata.

meta_keywordsArray <Stringa> nullObbligatorio

Parole chiave per i motori di ricerca nella lingua selezionata.

meta_titleStringa nullObbligatorio

Titolo per i motori di ricerca nella lingua selezionata.

numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

titleStringa nullObbligatorio

Titolo nella lingua selezionata.

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Campi · meta

ContextPageMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

ContextMeta

localeStringaObbligatorio

Lingua selezionata per questa richiesta.

market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio di risposta

Stato HTTP

200
Risposta riuscita Schema
400
Richiesta non valida
401
Autenticazione richiesta
403
Permesso negato
404
Risorsa non trovata
409
Conflitto di versione
422
Validazione non riuscita
429
Limite di richieste superato
Altri stati HTTP (7)
405
Metodo non consentito
413
Richiesta troppo grande
415
Formato non supportato
500
Errore del server
502
Errore del gateway API
503
Servizio non disponibile
504
Tempo di attesa scaduto

Catalogo degli errori: ErrorResponse

Header

401

WWW-AuthenticateStringaFacoltativo

Schema di autenticazione richiesto dal server.

405

AllowStringaFacoltativo

Metodi HTTP supportati da questa risorsa.

429, 503

Retry-AfterInteroFacoltativo

Attesa minima prima di riprovare, in secondi.

minimum: 0