Obtener — Páginas CMS
Consulta los datos de «Páginas CMS». El resultado depende de los parámetros de esta operación.
GET/api/v1/pages/{page_id}
- Autenticación
Bearer- Disponible desde
- STANDARD
- Permisos necesarios
content.page:read
Ejemplos de código
Ejemplo de solicitud
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))
Ejemplo de respuesta 200
{
"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"
}
}
Cómo funciona
- Las escrituras de páginas abarcan título, slug, contenido HTML, metadatos SEO, estado de publicación y ámbito de mercados admitido.
- Elige explícitamente el idioma al mantener contenido traducido.
- PATCH cambia únicamente los campos enviados.
- Se admite null solo cuando el esquema y el contexto permiten borrar un valor.
- Siguen vigentes las reglas de publicación, validación de contenido y plan.
Parámetros
Parámetros de ruta
page_idCadena de textoObligatorioIdentificador de la página CMS.
Restricciones
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Parámetros de consulta
localeCadena de texto nullOpcionalIdioma seleccionado para esta solicitud.
Cadena de texto:minLength:2maxLength:20market_idCadena de texto nullOpcionalIdentificador del mercado devuelto por el endpoint de contexto.
Restricciones · Cadena de texto 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeCadena de texto nullOpcionalCódigo del mercado devuelto por el endpoint de contexto.
Cadena de texto:minLength:1maxLength:16
Esta operación no acepta un cuerpo JSON.
Respuestas
Respuesta 200
Modelo completo: ApiResponse_PageDetailData_
dataPageDetailDataObligatorioContenido de una respuesta correcta.
Campos ·
dataModelo completo:
PageDetailDatabody_htmlCadena de texto nullObligatorioContenido de la página en HTML.
created_atCadena de textoObligatorioMomento de creación.
format:"date-time"idCadena de textoObligatorioIdentificador del recurso; consérvalo tal como se devuelve.
is_availableBooleanoObligatorioIndica si el elemento está disponible en este contexto.
market_scopeCadena de textoObligatorioIndica si el recurso se aplica a todos los mercados o solo a los seleccionados.
Restricciones
enum["all", "selected"]
meta_descriptionCadena de texto nullObligatorioDescripción para buscadores en el idioma seleccionado.
meta_keywordsLista <Cadena de texto> nullObligatorioPalabras clave para buscadores en el idioma seleccionado.
meta_titleCadena de texto nullObligatorioTítulo para buscadores en el idioma seleccionado.
numberCadena de textoObligatorioNúmero de pedido o solicitud mostrado al usuario.
publishedBooleanoObligatorioIndica si el recurso está publicado.
slugCadena de texto nullObligatorioSegmento de la ruta URL en el idioma seleccionado.
titleCadena de texto nullObligatorioTítulo en el idioma seleccionado.
updated_atCadena de textoObligatorioMomento de la última actualización.
format:"date-time"versionNúmero enteroObligatorioVersión del recurso utilizada para controlar cambios simultáneos.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatorioMetadatos de la respuesta.
Campos ·
metaModelo completo:
ContextPageMetalocaleCadena de textoObligatorioIdioma seleccionado para esta solicitud.
market_codeCadena de textoObligatorioCódigo del mercado devuelto por el endpoint de contexto.
market_idCadena de textoObligatorioIdentificador del mercado devuelto por el endpoint de contexto.
paginationPaginationObligatorioMetadatos de la paginación por cursor.
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
localeCadena de textoObligatorioIdioma seleccionado para esta solicitud.
market_codeCadena de textoObligatorioCódigo del mercado devuelto por el endpoint de contexto.
market_idCadena de textoObligatorioIdentificador del mercado devuelto por el endpoint de contexto.
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
paginationPaginationObligatorioMetadatos de la paginación por cursor.
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
request_idCadena de textoObligatorioIdentificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.
minLength:1maxLength:100
Estado HTTP
200- Respuesta correcta Esquema
400- Solicitud no válida
401- Autenticación necesaria
403- Permiso denegado
404- Recurso no encontrado
409- Conflicto de versión
422- Error de validación
429- Límite de solicitudes excedido
Otros estados HTTP (7)
405- Método no permitido
413- Solicitud demasiado grande
415- Formato no compatible
500- Error del servidor
502- Error de la pasarela API
503- Servicio no disponible
504- Tiempo de espera agotado
Catálogo de errores: ErrorResponse
Cabeceras
401
WWW-AuthenticateCadena de textoOpcionalEsquema de autenticación exigido por el servidor.
405
AllowCadena de textoOpcionalMétodos HTTP admitidos por este recurso.
429, 503
Retry-AfterNúmero enteroOpcionalEspera mínima antes de reintentar, en segundos.
minimum:0