Ny artikkel
Opprette artikkelutkast
POST/api/v1/addons/shopently.blog/posts
- Autentisering
Bearer- Tilgjengelig fra
- BASIC
- Påkrevd installert modul
shopently.blog· Modulets kontraktversjon 1- Nødvendige tilganger
addon.shopently.blog:post_create
Kodeeksempler
Eksempel på forespørsel
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request POST \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: learn-8ee78b431a9e4a4198d15a5dd386bb14' \
--header 'Content-Type: application/json' \
--data-raw '{
"author_id": "341494e0-caab-4f47-a8ff-f6795c42a775",
"comments_mode": "open",
"content_html": "<h2>Porównaj właściwości</h2><p>Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.</p>",
"cover_alt": "Niebieska ilustracja poradnika",
"cover_caption": "Ilustracja redakcyjna",
"cover_media_id": "e8663afe-3c38-461c-a142-a980085630af",
"excerpt": "Praktyczny poradnik zakupowy.",
"locale": "pl",
"meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.",
"meta_keywords": [
"poradnik",
"wybór"
],
"meta_title": "Jak wybrać produkt",
"slug": "jak-wybrac-produkt",
"title": "Jak wybrać produkt"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/posts
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-8ee78b431a9e4a4198d15a5dd386bb14', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/posts');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'POST',
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, '{
"author_id": "341494e0-caab-4f47-a8ff-f6795c42a775",
"comments_mode": "open",
"content_html": "<h2>Porównaj właściwości</h2><p>Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.</p>",
"cover_alt": "Niebieska ilustracja poradnika",
"cover_caption": "Ilustracja redakcyjna",
"cover_media_id": "e8663afe-3c38-461c-a142-a980085630af",
"excerpt": "Praktyczny poradnik zakupowy.",
"locale": "pl",
"meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.",
"meta_keywords": [
"poradnik",
"wybór"
],
"meta_title": "Jak wybrać produkt",
"slug": "jak-wybrac-produkt",
"title": "Jak wybrać produkt"
}');
$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-8ee78b431a9e4a4198d15a5dd386bb14'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "author_id": "341494e0-caab-4f47-a8ff-f6795c42a775",\n "comments_mode": "open",\n "content_html": "<h2>Porównaj właściwości</h2><p>Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.</p>",\n "cover_alt": "Niebieska ilustracja poradnika",\n "cover_caption": "Ilustracja redakcyjna",\n "cover_media_id": "e8663afe-3c38-461c-a142-a980085630af",\n "excerpt": "Praktyczny poradnik zakupowy.",\n "locale": "pl",\n "meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.",\n "meta_keywords": [\n "poradnik",\n "wybór"\n ],\n "meta_title": "Jak wybrać produkt",\n "slug": "jak-wybrac-produkt",\n "title": "Jak wybrać produkt"\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(
'POST', base_url + '/api/v1/addons/shopently.blog/posts', 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))
Eksempel på svar 201
{
"data": {
"html_normalized": false,
"id": "2103ba96-2713-420b-b197-8a008730c851",
"public_number": 1,
"revision_id": "8c4af6da-63f4-42aa-8b37-57c703fa0af7",
"status": "draft",
"version": 1
},
"meta": {
"request_id": "f6a16d96-69fc-401d-9d04-cdc96f86a4c7"
}
}
Oversikt
Driv butikkens blogg med HTML-artikler, bilder, forfattere og metadata for søkemotorer. Lagre utkast, klargjør oversettelser og publiser straks eller på et valgt tidspunkt i en bestemt tidssone. Administrer kommentarer og moderering i panelet; en ekstern generator kan bruke API-et med rettighetene du tildeler.
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:post_create
Parametere
Forespørselshoder
Idempotency-KeyStrengObligatoriskUnik identifikator for én logisk skriveoperasjon.
minLength:1maxLength:128Begrensninger
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Forespørselsinnhold
application/json · Obligatorisk
author_idStreng nullObligatoriskForfatter
Streng:format:"uuid"comments_modeStrengObligatoriskKommentarer
Begrensninger
enum["inherit", "open", "closed"]
content_htmlStrengObligatoriskInnhold
maxLength:50000cover_altStrengObligatoriskAlternativ tekst
maxLength:250cover_captionStrengObligatoriskBildetekst
maxLength:500cover_media_idStreng nullObligatoriskForsidebilde
Streng:format:"uuid"excerptStrengObligatoriskIntroduksjon
maxLength:1000expected_versionHeltallValgfrittVersjon lest før skriveoperasjonen; et avvik avviser oppdateringen.
const:1localeStrengObligatoriskSpråk valgt for denne forespørselen.
minLength:2maxLength:35Begrensninger
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
meta_descriptionStrengObligatoriskSøkemotorbeskrivelse på valgt språk.
maxLength:160meta_keywordsArray <Streng> ObligatoriskSøkemotornøkkelord på valgt språk.
maxItems:20Array:minLength:1maxLength:50meta_titleStrengObligatoriskSøkemotortittel på valgt språk.
maxLength:70slugStrengObligatoriskURL-stisegment på valgt språk.
maxLength:160titleStrengObligatoriskTittel på valgt språk.
maxLength:200
Svar
Svar 201
dataObjektYtterligere felt: NeiObligatoriskInnholdet i et vellykket svar.
Felter ·
datahtml_normalizedBoolsk verdiObligatoriskHTML · category-v1
idStrengObligatoriskRessursidentifikator; behold den slik den returneres.
format:"uuid"public_numberHeltall nullValgfrittNummer
Heltall:minimum:1revision_idStrengObligatoriskRevisjon
format:"uuid"statusStrengObligatoriskStatus som godtas av denne bestemte operasjonen.
Begrensninger
enum["draft", "scheduled", "published", "archived"]
versionHeltallObligatoriskRessursversjon brukt til samtidighetskontroll.
minimum:1maximum:9223372036854775807
metaObjektYtterligere felt: NeiObligatoriskSvarmetadata.
Felter ·
metarequest_idStrengObligatoriskSaksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.
minLength:1maxLength:100
HTTP-status
201- Ressurs opprettet Skjema
400- Ugyldig forespørsel
401- Autentisering kreves
403- Tilgang nektet
404- Ressursen ble ikke funnet
409- Versjonskonflikt
422- Validering mislyktes
429- Forespørselsgrensen er overskredet
Andre HTTP-statuser (7)
405- Metoden er ikke tillatt
413- Forespørselen er for stor
415- Formatet støttes ikke
500- Serverfeil
502- Feil i API-gateway
503- Tjenesten er utilgjengelig
504- Tidsavbrudd
Feilkatalog: ErrorResponse
Headere
401
WWW-AuthenticateStrengValgfrittAutentiseringsmetode serveren krever.
405
AllowStrengValgfrittHTTP-metoder denne ressursen støtter.
429, 503
Retry-AfterHeltallValgfrittMinste ventetid før neste forsøk, i sekunder.
minimum:0