Aller au contenu
ShopentlyLearn

Publier · Articles

Publier, programmer et archiver les articles

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

Authentification
Bearer
Disponible à partir de
BASIC
Module installé requis
shopently.blog · Version du contrat du module 1
Autorisations requises
addon.shopently.blog:post_publish

Exemples de code

Exemple de requête

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-d4d47592948e4567a1511a4e797467af' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 2,
  "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/publish

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-d4d47592948e4567a1511a4e797467af', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/posts/2103ba96-2713-420b-b197-8a008730c851/publish');
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": 2,
  "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40"
}');
$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-d4d47592948e4567a1511a4e797467af'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 2,\n  "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40"\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/publish', 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))

Exemple de réponse 200

JSON
{
  "data": {
    "id": "2103ba96-2713-420b-b197-8a008730c851",
    "status": "published",
    "version": 3
  },
  "meta": {
    "request_id": "ebb0a3b6-a737-4b64-8ac9-8e2a39e7ab46"
  }
}

Vue d’ensemble

Animez le blog de votre boutique avec des articles HTML, des photos, des auteurs et des métadonnées pour les moteurs de recherche. Enregistrez des brouillons, préparez des traductions et publiez immédiatement ou à une heure choisie dans un fuseau précis. Gérez les commentaires et leur modération dans le panneau ; un générateur externe peut utiliser l’API avec les autorisations accordées.

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

Paramètres

Paramètres de chemin

post_idChaîneObligatoire

Article

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

En-têtes de requête

Idempotency-KeyChaîneObligatoire

Identifiant unique d'une opération logique d'écriture.

minLength: 1maxLength: 128
Contraintes
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Exemple: "learn-d4d47592948e4567a1511a4e797467af"

Corps de la requête

application/json · Obligatoire

ObjetChamps supplémentaires: Non
expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807
revision_idChaîneObligatoire

Révision

format: "uuid"

Réponses

Réponse 200

dataObjetChamps supplémentaires: NonObligatoire

Données d'une réponse réussie.

Champs · data
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"
statusChaîneObligatoire

Statut accepté par cette opération précise.

Contraintes
enum
["draft", "scheduled", "published", "archived"]
versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

minimum: 1maximum: 9223372036854775807
metaObjetChamps supplémentaires: NonObligatoire

Métadonnées de la réponse.

Champs · meta
request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100
Exemple de réponse

Statut HTTP

200
Réponse réussie Schéma
400
Requête invalide
401
Authentification requise
403
Accès refusé
404
Ressource introuvable
409
Conflit de version
422
Échec de validation
429
Limite de requêtes dépassée
Autres statuts HTTP (7)
405
Méthode non autorisée
413
Requête trop volumineuse
415
Format non pris en charge
500
Erreur du serveur
502
Erreur de passerelle API
503
Service indisponible
504
Délai de passerelle dépassé

Catalogue des erreurs: ErrorResponse

En-têtes

401

WWW-AuthenticateChaîneFacultatif

Schéma d'authentification exigé par le serveur.

405

AllowChaîneFacultatif

Méthodes HTTP prises en charge par cette ressource.

429, 503

Retry-AfterEntierFacultatif

Délai minimal avant une nouvelle tentative, en secondes.

minimum: 0