Přejít na obsah
ShopentlyLearn

Vytvořit · Pravidla — Analytika a pravidla vyhledávání

Proveďte „Vytvořit · Pravidla“ v „Analytika a pravidla vyhledávání“ s níže popsanými daty.

POST/api/v1/search/rules

Ověřování
Bearer
Dostupné od tarifu
STANDARD
Požadovaná oprávnění
search.rule:create

Příklady kódu

Příklad požadavku

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: example-create_rule_api_v1_search_rules_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "Example",
  "phrases": [
    "example"
  ],
  "product_ids": [
    "example"
  ]
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/search/rules

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: example-create_rule_api_v1_search_rules_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/search/rules');
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, '{
  "name": "Example",
  "phrases": [
    "example"
  ],
  "product_ids": [
    "example"
  ]
}');
$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': 'example-create_rule_api_v1_search_rules_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "name": "Example",\n  "phrases": [\n    "example"\n  ],\n  "product_ids": [\n    "example"\n  ]\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/search/rules', 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))

Příklad odpovědi 201

JSON
{
  "data": {
    "deleted": false,
    "id": "example",
    "version": 1
  },
  "meta": {
    "request_id": "example"
  }
}

Jak to funguje

  • GET /api/v1/search/overview a /api/v1/search/queries zpřístupňují souhrnné statistiky a seskupené dotazy.
  • Jednotlivé výskyty dotazu načtěte pomocí query_hash.
  • Období přehledu může mít 7, 30 nebo 90 dní s filtry uvedenými u jednotlivých koncových bodů.
  • Pravidla vyhledávání propojují fráze s vybranými produkty a kategoriemi a lze je vytvářet, číst, upravovat i mazat.
  • Pravidla a analytika mají oddělená oprávnění; čtení statistik vyhledávání neuděluje přístup k nastavení.

Parametry

Parametry dotazu

localeŘetězec nullVolitelné

Jazyk vybraný pro tento požadavek.

Řetězec:minLength: 2maxLength: 20
market_idŘetězec nullVolitelné

Identifikátor trhu vrácený koncovým bodem kontextu.

Omezení · Řetězec 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeŘetězec nullVolitelné

Kód trhu vrácený koncovým bodem kontextu.

Řetězec:minLength: 1maxLength: 16

Hlavičky požadavku

Idempotency-KeyŘetězecPovinné

Jedinečný identifikátor jedné logické operace zápisu.

minLength: 1maxLength: 128
Omezení
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Příklad: "example-create_rule_api_v1_search_rules_post"

Tělo požadavku

application/json · Povinné

RuleCreate
category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 100
Pole:minLength: 1maxLength: 63
enabledLogická hodnotaVolitelné

Zda je nastavení zapnuto.

Výchozí hodnota: false
market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000
Pole:minLength: 1maxLength: 63
market_scopeŘetězecVolitelné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení
enum
["all", "selected"]
nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160
Příklad: "Example"
phrasesPole <Řetězec> Povinné

Fráze používané pravidlem vyhledávání.

minItems: 1maxItems: 20
Pole:minLength: 1maxLength: 255
Příklad: ["example"]
product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 100
Pole:minLength: 1maxLength: 63
Příklad: ["example"]

Odpovědi

Odpověď 201

dataMutationData Povinné

Obsah úspěšné odpovědi.

Pole · data
deletedLogická hodnotaPovinné

Zda bylo smazání provedeno.

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

versionCelé číslo nullPovinné

Verze zdroje používaná k řízení souběžných změn.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Pole · meta

ContextPageMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

ContextMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

201
Zdroj vytvořen Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

201

LocationŘetězecVolitelné

Relativní URL vytvořeného zdroje.

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0