Pular para o conteúdo
ShopentlyLearn

Editar artigo

Editar rascunhos de artigos e traduções

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

Autenticação
Bearer
Disponível a partir de
BASIC
Módulo instalado necessário
shopently.blog · Versão do contrato do módulo 1
Permissões necessárias
addon.shopently.blog:post_update

Exemplos de código

Exemplo de requisição

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

Exemplo de resposta 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"
  }
}

Visão geral

Gerencie o blog da sua loja com artigos HTML, fotos, autores e metadados para buscadores. Salve rascunhos, prepare traduções e publique imediatamente ou em um horário escolhido em um fuso específico. Gerencie comentários e moderação no painel; um gerador externo pode usar a API com as permissões concedidas.

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

Parâmetros

Parâmetros do caminho

post_idTextoObrigatório

Artigo

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

Cabeçalhos da requisição

Idempotency-KeyTextoObrigatório

Identificador único de uma operação lógica de escrita.

minLength: 1maxLength: 128
Restrições
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Exemplo: "learn-6486f38921214552949f30311a1f543f"

Corpo da requisição

application/json · Obrigatório

ObjetoCampos adicionais: Não
author_idTexto nullOpcional

Autor

Texto:format: "uuid"
comments_modeTextoOpcional

Comentários

Restrições
enum
["inherit", "open", "closed"]
content_htmlTextoOpcional

Conteúdo

maxLength: 50000
cover_altTextoOpcional

Texto alternativo

maxLength: 250
cover_captionTextoOpcional

Legenda da foto

maxLength: 500
cover_media_idTexto nullOpcional

Foto de capa

Texto:format: "uuid"
excerptTextoOpcional

Introdução

maxLength: 1000
expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807
localeTextoObrigatório

Idioma selecionado para esta requisição.

minLength: 2maxLength: 35
Restrições
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionTextoOpcional

Descrição para mecanismos de pesquisa no idioma selecionado.

maxLength: 160
meta_keywordsLista <Texto> Opcional

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

maxItems: 20
Lista:minLength: 1maxLength: 50
meta_titleTextoOpcional

Título para mecanismos de pesquisa no idioma selecionado.

maxLength: 70
slugTextoOpcional

Segmento do caminho da URL no idioma selecionado.

maxLength: 160
titleTextoOpcional

Título no idioma selecionado.

maxLength: 200

Respostas

Resposta 200

dataObjetoCampos adicionais: NãoObrigatório

Conteúdo de uma resposta bem-sucedida.

Campos · data
html_normalizedBooleanoObrigatório

HTML · category-v1

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"
public_numberNúmero inteiro nullOpcional

Número

Número inteiro:minimum: 1
revision_idTextoObrigatório

Revisão

format: "uuid"
statusTextoObrigatório

Estado aceito por esta operação específica.

Restrições
enum
["draft", "scheduled", "published", "archived"]
versionNúmero inteiroObrigatório

Versão do recurso utilizada para controle de concorrência.

minimum: 1maximum: 9223372036854775807
metaObjetoCampos adicionais: NãoObrigatório

Metadados da resposta.

Campos · meta
request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Requisição inválida
401
Autenticação necessária
403
Permissão negada
404
Recurso não encontrado
409
Conflito de versão
422
Falha na validação
429
Limite de requisições excedido
Outros status HTTP (7)
405
Método não permitido
413
Requisição muito grande
415
Formato não suportado
500
Erro do servidor
502
Erro do gateway da API
503
Serviço indisponível
504
Tempo de espera excedido

Catálogo de erros: ErrorResponse

Cabeçalhos

401

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0