Léim ar ábhar
ShopentlyLearn

Cuir alt in eagar

Dréachtaí alt agus aistriúcháin a chur in eagar

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

Fíordheimhniú
Bearer
Ar fáil ó
BASIC
Modúl suiteáilte riachtanach
shopently.blog · Leagan de chonradh an mhodúil 1
Ceadanna riachtanacha
addon.shopently.blog:post_update

Samplaí cóid

Sampla iarratais

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

Sampla freagra 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"
  }
}

Forléargas

Reáchtáil blag do shiopa le hailt HTML, grianghraif, údair agus meiteashonraí d’innill chuardaigh. Sábháil dréachtaí, ullmhaigh aistriúcháin agus foilsigh láithreach nó ag am roghnaithe i gcrios ama ar leith. Bainistigh tráchtanna agus modhnóireacht sa phainéal; is féidir le gineadóir seachtrach an API a úsáid leis na ceadanna a dheonaíonn tú.

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

Paraiméadair

Paraiméadair chosáin

post_idTeaghránRiachtanach

Alt

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

Ceanntásca iarratais

Idempotency-KeyTeaghránRiachtanach

Aitheantóir uathúil d'oibríocht loighciúil scríbhneoireachta amháin.

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

Corp an iarratais

application/json · Riachtanach

OibiachtRéimsí breise: Níl
author_idTeaghrán nullRoghnach

Údar

Teaghrán:format: "uuid"
comments_modeTeaghránRoghnach

Tráchtanna

Srianta
enum
["inherit", "open", "closed"]
content_htmlTeaghránRoghnach

Ábhar

maxLength: 50000
cover_altTeaghránRoghnach

Téacs malartach

maxLength: 250
cover_captionTeaghránRoghnach

Fotheideal an ghrianghraif

maxLength: 500
cover_media_idTeaghrán nullRoghnach

Grianghraf clúdaigh

Teaghrán:format: "uuid"
excerptTeaghránRoghnach

Réamhrá

maxLength: 1000
expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1maximum: 9223372036854775807
localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

minLength: 2maxLength: 35
Srianta
pattern
"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionTeaghránRoghnach

Cur síos inneall cuardaigh sa teanga roghnaithe.

maxLength: 160
meta_keywordsEagar <Teaghrán> Roghnach

Eochairfhocail inneall cuardaigh sa teanga roghnaithe.

maxItems: 20
Eagar:minLength: 1maxLength: 50
meta_titleTeaghránRoghnach

Teideal inneall cuardaigh sa teanga roghnaithe.

maxLength: 70
slugTeaghránRoghnach

Cuid de chosán URL sa teanga roghnaithe.

maxLength: 160
titleTeaghránRoghnach

Teideal sa teanga roghnaithe.

maxLength: 200

Freagraí

Freagra 200

dataOibiachtRéimsí breise: NílRiachtanach

Sonraí freagra rathúil.

Réimsí · data
html_normalizedLuach BooleRiachtanach

HTML · category-v1

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

format: "uuid"
public_numberSlánuimhir nullRoghnach

Uimhir

Slánuimhir:minimum: 1
revision_idTeaghránRiachtanach

Leagan

format: "uuid"
statusTeaghránRiachtanach

Stádas a ghlacann an oibríocht áirithe seo.

Srianta
enum
["draft", "scheduled", "published", "archived"]
versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

minimum: 1maximum: 9223372036854775807
metaOibiachtRéimsí breise: NílRiachtanach

Meiteashonraí an fhreagra.

Réimsí · meta
request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100
Sampla freagra

Stádas HTTP

200
Freagra rathúil Scéim
400
Iarratas neamhbhailí
401
Fíordheimhniú riachtanach
403
Cead diúltaithe
404
Acmhainn gan aimsiú
409
Coinbhleacht leagain
422
Theip ar bhailíochtú
429
Teorainn iarratas sáraithe
Stádais HTTP eile (7)
405
Modh neamhcheadaithe
413
Iarratas rómhór
415
Formáid gan tacaíocht
500
Earráid freastalaí
502
Earráid gheata API
503
Seirbhís gan fáil
504
Teorainn ama sáraithe

Catalóg earráidí: ErrorResponse

Ceanntásca

401

WWW-AuthenticateTeaghránRoghnach

An scéim fíordheimhnithe a éilíonn an freastalaí.

405

AllowTeaghránRoghnach

Modhanna HTTP a thacaíonn an acmhainn seo leo.

429, 503

Retry-AfterSlánuimhirRoghnach

An mhoill íosta roimh atriail, i soicindí.

minimum: 0