Saltar al contenido
ShopentlyLearn

Editar artículo

Editar borradores de artículos y traducciones

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

Autenticación
Bearer
Disponible desde
BASIC
Módulo instalado requerido
shopently.blog · Versión del contrato del módulo 1
Permisos necesarios
addon.shopently.blog:post_update

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 PATCH \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: learn-6486f38921214552949f30311a1f543f' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.",
  "expected_version": 1,
  "locale": "pl"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851

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 = ['Idempotency-Key: learn-6486f38921214552949f30311a1f543f', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    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);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
  "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.",
  "expected_version": 1,
  "locale": "pl"
}');
$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 = {'Idempotency-Key': 'learn-6486f38921214552949f30311a1f543f'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.",\n  "expected_version": 1,\n  "locale": "pl"\n}'
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(
        'PATCH', base_url + '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851', 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

JSON
{
  "data": {
    "html_normalized": false,
    "id": "2103ba96-2713-420b-b197-8a008730c851",
    "public_number": null,
    "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40",
    "status": "draft",
    "version": 2
  },
  "meta": {
    "request_id": "bd4bb9ba-0f29-41c0-858d-3581bb03928f"
  }
}

Vista general

Gestiona el blog de tu tienda con artículos HTML, fotos, autores y metadatos para buscadores. Guarda borradores, prepara traducciones y publica al instante o a una hora elegida en una zona horaria concreta. Gestiona los comentarios y su moderación en el panel; un generador externo puede usar la API con los permisos que concedas.

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

Parámetros

Parámetros de ruta

post_idCadena de textoObligatorio

Artículo

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

Cabeceras de solicitud

Idempotency-KeyCadena de textoObligatorio

Identificador único de una operación lógica de escritura.

minLength: 1maxLength: 128
Restricciones
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Ejemplo: "learn-6486f38921214552949f30311a1f543f"

Cuerpo de la solicitud

application/json · Obligatorio

ObjetoCampos adicionales: No
author_idCadena de texto nullOpcional

Autor

Cadena de texto:format: "uuid"
comments_modeCadena de textoOpcional

Comentarios

Restricciones
enum
["inherit", "open", "closed"]
content_htmlCadena de textoOpcional

Contenido

maxLength: 50000
cover_altCadena de textoOpcional

Texto alternativo

maxLength: 250
cover_captionCadena de textoOpcional

Pie de foto

maxLength: 500
cover_media_idCadena de texto nullOpcional

Foto de portada

Cadena de texto:format: "uuid"
excerptCadena de textoOpcional

Introducción

maxLength: 1000
expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807
localeCadena de textoObligatorio

Idioma seleccionado para esta solicitud.

minLength: 2maxLength: 35
Restricciones
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionCadena de textoOpcional

Descripción para buscadores en el idioma seleccionado.

maxLength: 160
meta_keywordsLista <Cadena de texto> Opcional

Palabras clave para buscadores en el idioma seleccionado.

maxItems: 20
Lista:minLength: 1maxLength: 50
meta_titleCadena de textoOpcional

Título para buscadores en el idioma seleccionado.

maxLength: 70
slugCadena de textoOpcional

Segmento de la ruta URL en el idioma seleccionado.

maxLength: 160
titleCadena de textoOpcional

Título en el idioma seleccionado.

maxLength: 200

Respuestas

Respuesta 200

dataObjetoCampos adicionales: NoObligatorio

Contenido de una respuesta correcta.

Campos · data
html_normalizedBooleanoObligatorio

HTML · category-v1

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve.

format: "uuid"
public_numberNúmero entero nullOpcional

Número

Número entero:minimum: 1
revision_idCadena de textoObligatorio

Revisión

format: "uuid"
statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Restricciones
enum
["draft", "scheduled", "published", "archived"]
versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

minimum: 1maximum: 9223372036854775807
metaObjetoCampos adicionales: NoObligatorio

Metadatos de la respuesta.

Campos · meta
request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100
Ejemplo de respuesta

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 textoOpcional

Esquema de autenticación exigido por el servidor.

405

AllowCadena de textoOpcional

Métodos HTTP admitidos por este recurso.

429, 503

Retry-AfterNúmero enteroOpcional

Espera mínima antes de reintentar, en segundos.

minimum: 0