Redaguoti autorių
Redaguoti ir išjungti straipsnių autorius
PATCH/api/v1/addons/shopently.blog/authors/{author_id}
- Tapatybės patvirtinimas
Bearer- Prieinama nuo plano
- BASIC
- Būtinas įdiegtas modulis
shopently.blog· Modulio sutarties versija 1- Būtinos teisės
addon.shopently.blog:author_update
Kodo pavyzdžiai
Užklausos pavyzdys
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-7c99f12fb68a4980bc88c809fbe4268a' \
--header 'Content-Type: application/json' \
--data-raw '{
"biography": "Practical guides from our editorial team.",
"expected_version": 1
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/authors/341494e0-caab-4f47-a8ff-f6795c42a775
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-7c99f12fb68a4980bc88c809fbe4268a', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/authors/341494e0-caab-4f47-a8ff-f6795c42a775');
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, '{
"biography": "Practical guides from our editorial team.",
"expected_version": 1
}');
$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-7c99f12fb68a4980bc88c809fbe4268a'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "biography": "Practical guides from our editorial team.",\n "expected_version": 1\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/authors/341494e0-caab-4f47-a8ff-f6795c42a775', 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))
Atsakymo pavyzdys 200
{
"data": {
"id": "341494e0-caab-4f47-a8ff-f6795c42a775",
"version": 2
},
"meta": {
"request_id": "6f9d2db8-6c93-43e2-a081-a9c6f3ddb743"
}
}
Apžvalga
Tvarkykite parduotuvės tinklaraštį su HTML straipsniais, nuotraukomis, autoriais ir paieškos sistemų metaduomenimis. Saugokite juodraščius, ruoškite vertimus ir publikuokite iš karto arba pasirinktu laiku konkrečioje laiko juostoje. Valdykite komentarus ir moderavimą skydelyje; išorinis generatorius gali naudoti API su suteiktomis teisėmis.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:author_update
Parametrai
Kelio parametrai
author_idEilutėPrivalomasAutorius
format:"uuid"
Užklausos antraštės
Idempotency-KeyEilutėPrivalomasVienos loginės įrašymo operacijos unikalus identifikatorius.
minLength:1maxLength:128Apribojimai
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Užklausos turinys
application/json · Privalomas
biographyEilutėNeprivalomasBiografija
maxLength:5000display_nameEilutėNeprivalomasVardas
minLength:1maxLength:160expected_versionSveikasis skaičiusPrivalomasPrieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.
minimum:1maximum:9223372036854775807is_activeLoginė reikšmėNeprivalomasAktyvus
Atsakymai
Atsakymas 200
dataObjektasPapildomi laukai: NePrivalomasSėkmingo atsakymo duomenys.
Laukai ·
dataidEilutėPrivalomasIštekliaus identifikatorius; išsaugokite grąžintą išraišką.
format:"uuid"versionSveikasis skaičiusPrivalomasIštekliaus versija lygiagrečių pakeitimų kontrolei.
minimum:1maximum:9223372036854775807
metaObjektasPapildomi laukai: NePrivalomasAtsakymo metaduomenys.
Laukai ·
metarequest_idEilutėPrivalomasPrašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength:1maxLength:100
HTTP būsena
200- Sėkmingas atsakymas Schema
400- Netinkama užklausa
401- Būtinas tapatybės patvirtinimas
403- Prieiga uždrausta
404- Išteklius nerastas
409- Versijų konfliktas
422- Tikrinimo klaida
429- Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405- Metodas neleidžiamas
413- Užklausa per didelė
415- Nepalaikomas formatas
500- Serverio klaida
502- API tinklų sietuvo klaida
503- Paslauga nepasiekiama
504- Baigėsi laukimo laikas
Klaidų katalogas: ErrorResponse
Antraštės
401
WWW-AuthenticateEilutėNeprivalomasServerio reikalaujama tapatybės patvirtinimo schema.
405
AllowEilutėNeprivalomasŠio ištekliaus palaikomi HTTP metodai.
429, 503
Retry-AfterSveikasis skaičiusNeprivalomasMažiausias laukimo laikas prieš kartojant, sekundėmis.
minimum:0