Hoppa till innehållet
ShopentlyLearn

Lista · Författare

Visa artikelförfattare

GET/api/v1/addons/shopently.blog/authors

Autentisering
Bearer
Tillgänglig från
BASIC
Installerad modul som krävs
shopently.blog · Modulens kontraktsversion 1
Behörigheter som krävs
addon.shopently.blog:author_read

Kodexempel

Exempel på begäran

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/addons/shopently.blog/authors?limit=10'

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 = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/addons/shopently.blog/authors?limit=10');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    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);
    },
]);
$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 = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
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(
        'GET', base_url + '/api/v1/addons/shopently.blog/authors?limit=10', 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))

Exempel på svar 200

JSON
{
  "data": [
    {
      "biography_preview": "Guides prepared by our editorial team.",
      "display_name": "Store editorial team",
      "id": "341494e0-caab-4f47-a8ff-f6795c42a775",
      "is_active": true,
      "version": 1
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 10,
      "next_cursor": null
    },
    "request_id": "6cb2a484-9612-473c-bbc7-deece9a4dd7d"
  }
}

Översikt

Driv butikens blogg med HTML-artiklar, foton, författare och metadata för sökmotorer. Spara utkast, förbered översättningar och publicera direkt eller vid en vald tidpunkt i en viss tidszon. Hantera kommentarer och moderering i panelen; en extern generator kan använda API:et med de behörigheter du ger.

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

Parametrar

Frågeparametrar

limitHeltalValfritt

Högsta antal poster på denna sida.

minimum: 1maximum: 100
Standardvärde: 50Exempel: 10
cursorSträng nullValfritt

Ogenomskinligt fortsättningsvärde från föregående sida.

Sträng:maxLength: 512

Den här operationen tar inte emot JSON-innehåll.

Svar

Svar 200

dataArray <ObjektYtterligare fält: Nej> Obligatoriskt

Innehållet i ett lyckat svar.

maxItems: 100
Fält · data

ObjektYtterligare fält: Nej

biography_previewSträngObligatoriskt

Biografi

maxLength: 250
display_nameSträngObligatoriskt

Namn

minLength: 1maxLength: 160
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

format: "uuid"
is_activeBooleskt värdeObligatoriskt

Aktiv

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

minimum: 1maximum: 9223372036854775807
metaObjektYtterligare fält: NejObligatoriskt

Metadata för svaret.

Fält · meta
paginationObjektYtterligare fält: NejObligatoriskt

Metadata för markörbaserad paginering.

Fält · pagination
has_moreBooleskt värdeObligatoriskt

Anger om det finns ytterligare en sida.

limitHeltalObligatoriskt

Högsta antal poster på denna sida.

minimum: 1maximum: 100
next_cursorSträng nullObligatoriskt

Fortsättningsvärde för nästa sida, eller null.

Sträng:maxLength: 512
request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel på svar

HTTP-status

200
Lyckat svar Schema
400
Ogiltig begäran
401
Autentisering krävs
403
Åtkomst nekad
404
Resursen hittades inte
409
Versionskonflikt
422
Valideringen misslyckades
429
Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405
Metoden tillåts inte
413
För stor begäran
415
Formatet stöds inte
500
Serverfel
502
Fel i API-gateway
503
Tjänsten är inte tillgänglig
504
Tidsgränsen överskreds

Felkatalog: ErrorResponse

HTTP-huvuden

401

WWW-AuthenticateSträngValfritt

Autentiseringsschema som servern kräver.

405

AllowSträngValfritt

HTTP-metoder som resursen stöder.

429, 503

Retry-AfterHeltalValfritt

Minsta väntetid före ett nytt försök, i sekunder.

minimum: 0