Preskoči na vsebino
ShopentlyLearn

Načrtuj objavo

Objavljanje, načrtovanje in arhiviranje člankov

POST/api/v1/addons/shopently.blog/posts/{post_id}/schedule

Preverjanje pristnosti
Bearer
Na voljo od paketa
BASIC
Zahtevani nameščeni modul
shopently.blog · Različica pogodbe modula 1
Zahtevana dovoljenja
addon.shopently.blog:post_publish

Primeri kode

Primer zahteve

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-4127e3d9922742cc912bda42fdba2422' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 4,
  "publish_at": "2026-10-08T23:17:45.449196+00:00",
  "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40",
  "timezone": "UTC"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/schedule

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-4127e3d9922742cc912bda42fdba2422', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/schedule');
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, '{
  "expected_version": 4,
  "publish_at": "2026-10-08T23:17:45.449196+00:00",
  "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40",
  "timezone": "UTC"
}');
$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-4127e3d9922742cc912bda42fdba2422'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 4,\n  "publish_at": "2026-10-08T23:17:45.449196+00:00",\n  "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40",\n  "timezone": "UTC"\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/2103ba96-2713-420b-b197-8a008730c851/schedule', 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))

Primer odgovora 200

JSON
{
  "data": {
    "id": "2103ba96-2713-420b-b197-8a008730c851",
    "publish_at": "2026-10-08T23:17:45.449196Z",
    "status": "scheduled",
    "version": 5
  },
  "meta": {
    "request_id": "d5d1037e-0776-4f63-a337-87335e26c5e4"
  }
}

Pregled

Vodite blog trgovine s članki HTML, fotografijami, avtorji in metapodatki za iskalnike. Shranjujte osnutke, pripravljajte prevode in objavljajte takoj ali ob izbranem času v določenem časovnem pasu. Upravljajte komentarje in moderiranje v nadzorni plošči; zunanji generator lahko uporablja API z dodeljenimi pravicami.

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

Parametri

Parametri poti

post_idNizObvezno

Članek

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

Glave zahteve

Idempotency-KeyNizObvezno

Enolični identifikator ene logične operacije zapisa.

minLength: 1maxLength: 128
Omejitve
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Primer: "learn-4127e3d9922742cc912bda42fdba2422"

Telo zahteve

application/json · Obvezno

ObjektDodatna polja: Ne
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
publish_atNizObvezno

Datum objave

format: "date-time"
revision_idNizObvezno

Različica

format: "uuid"
timezoneNizObvezno

Časovni pas

minLength: 1maxLength: 64

Odgovori

Odgovor 200

dataObjektDodatna polja: NeObvezno

Vsebina uspešnega odgovora.

Polja · data
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

format: "uuid"
publish_atNizObvezno

Datum objave

format: "date-time"
statusNizObvezno

Status, ki ga sprejema ta operacija.

Omejitve
enum
["draft", "scheduled", "published", "archived"]
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

minimum: 1maximum: 9223372036854775807
metaObjektDodatna polja: NeObvezno

Metapodatki odgovora.

Polja · meta
request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100
Primer odgovora

Status HTTP

200
Uspešen odgovor Shema
400
Neveljavna zahteva
401
Potrebna je avtentikacija
403
Dostop zavrnjen
404
Vir ni najden
409
Spor različic
422
Preverjanje ni uspelo
429
Presežena omejitev zahtev
Druga stanja HTTP (7)
405
Metoda ni dovoljena
413
Zahteva je prevelika
415
Nepodprta oblika
500
Napaka strežnika
502
Napaka prehoda API
503
Storitev ni na voljo
504
Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

401

WWW-AuthenticateNizIzbirno

Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno

Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno

Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0