新しいコメント
編集者のコメントを作成
POST/api/v1/addons/shopently.blog/comments
- 認証
Bearer- 利用可能な最低プラン
- BASIC
- 必要なインストール済みモジュール
shopently.blog· モジュール契約のバージョン 1- 必要な権限
addon.shopently.blog:comment_create
コード例
リクエスト例
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-e53442b24a8748e79c202f8ad4c82b9e' \
--header 'Content-Type: application/json' \
--data-raw '{
"body": "Zapraszamy do zadawania pytań.",
"display_name": "Redakcja",
"locale": "pl",
"post_id": "2103ba96-2713-420b-b197-8a008730c851"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/addons/shopently.blog/comments
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-e53442b24a8748e79c202f8ad4c82b9e', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/comments');
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, '{
"body": "Zapraszamy do zadawania pytań.",
"display_name": "Redakcja",
"locale": "pl",
"post_id": "2103ba96-2713-420b-b197-8a008730c851"
}');
$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-e53442b24a8748e79c202f8ad4c82b9e'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "body": "Zapraszamy do zadawania pytań.",\n "display_name": "Redakcja",\n "locale": "pl",\n "post_id": "2103ba96-2713-420b-b197-8a008730c851"\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/comments', 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))
レスポンス例 201
{
"data": {
"id": "2247b58d-1521-4fc0-9eec-6c47c259c181",
"status": "approved",
"version": 1
},
"meta": {
"request_id": "75ae817c-2925-48e0-ab57-1216a6e4ed45"
}
}
概要
HTML記事、写真、著者情報、検索用メタデータを使って店舗のブログを運営できます。下書きや翻訳を準備し、すぐに公開するか、指定したタイムゾーンの日時に公開を予約できます。管理画面でコメントと審査を管理でき、外部の生成ツールは付与された権限でAPIを利用できます。
BASIC · api.enabled · addons.use(shopently.blog) · addon.shopently.blog:comment_create
パラメーター
リクエストヘッダー
Idempotency-Key文字列必須1つの論理的な書き込み操作の一意な識別子。
minLength:1maxLength:128制約
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
リクエスト本文
application/json · 必須
body文字列必須コメント
minLength:1maxLength:5000display_name文字列必須名前
minLength:1maxLength:160expected_version整数任意書き込み前に取得したバージョン。不一致の場合は更新を拒否します。
const:1locale文字列必須このリクエストで選択した言語。
minLength:2maxLength:35制約
pattern"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$"
post_id文字列必須記事
format:"uuid"
レスポンス
レスポンス 201
dataオブジェクト追加フィールド: いいえ必須成功レスポンスのデータ。
フィールド ·
dataid文字列必須リソース識別子。返された値をそのまま保持してください。
format:"uuid"status文字列必須この操作で受け付けるステータス。
制約
enum["pending", "approved", "rejected", "spam"]
version整数必須同時更新制御に使うリソースバージョン。
minimum:1maximum:9223372036854775807
metaオブジェクト追加フィールド: いいえ必須レスポンスのメタデータ。
フィールド ·
metarequest_id文字列必須申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。
minLength:1maxLength:100
HTTP ステータス
201- リソースを作成しました スキーマ
400- 無効なリクエスト
401- 認証が必要です
403- 権限がありません
404- リソースが見つかりません
409- バージョンの競合
422- 検証エラー
429- リクエスト上限を超過
その他の HTTP ステータス (7)
405- 許可されていないメソッド
413- リクエストが大きすぎます
415- 未対応の形式
500- サーバーエラー
502- API ゲートウェイエラー
503- サービスを利用できません
504- タイムアウト
エラー一覧: ErrorResponse
ヘッダー
401
WWW-Authenticate文字列任意サーバーが要求する認証方式。
405
Allow文字列任意このリソースが対応する HTTP メソッド。
429, 503
Retry-After整数任意再試行までに最低限待つ秒数。
minimum:0