Kā izmantot Shoply AI Search API

Jā. Jūs varat programmatiski vaicāt Shoply AI Search no sava backend, neielādējot vietnē esošo logrīku un nesūtot pieprasījumu caur savu Shopify veikala skatlogu.

Standarta meklēšanas API ir pieejams ar katru Shopify plānu, kurā iekļauts AI Search, tostarp Forever Free. API pieprasījumi izmanto to pašu ikmēneša meklēšanas limitu kā meklējumi, kas veikti caur veikala skatloga logrīku. Pašreizējos limitus skatiet mūsu cenu lapā.

Ja jums nepieciešami augstāki limiti, pakalpojuma līmeņa vienošanās, pielāgots datu avots vai integrācija, kas neizmanto Shoply indeksētu Shopify katalogu, sazinieties ar mums par Enterprise plānu.

Pirms sākat

Instalējiet Shoply AI Shopify veikalā, kura katalogā vēlaties meklēt, un ļaujiet pabeigt sākotnējo produktu indeksēšanu. Jums būs nepieciešams veikala pastāvīgais myshopify.com domēns, piemēram:

your-store.myshopify.com

API var izsaukt no jebkuras backend vides. Atsevišķa API atslēga standarta produktu meklēšanas galapunktam nav nepieciešama, jo tas atgriež to pašu publisko kataloga informāciju, ko Shoply var parādīt veikala skatloga meklēšanas pieredzē.

Galapunkts

POST https://api.shoplyai.ai/product_query_v2
Content-Type: application/json

Pieprasījuma saturs

query ir JSON virkne pieprasījuma saturā, nevis ligzdots JSON objekts. Piemēram, meklēšanas frāze waterproof hiking boots tiek sūtīta šādi:

"{\"keywords\":\"waterproof hiking boots\"}"

cURL piemērs

Aizstājiet your-store.myshopify.com ar sava veikala pastāvīgo Shopify domēnu:

curl --request POST "https://api.shoplyai.ai/product_query_v2" \
  --header "Content-Type: application/json" \
  --data '{
    "store_key": "your-store.myshopify.com",
    "query": "{\"keywords\":\"waterproof hiking boots\"}",
    "start": 0,
    "limit": 8
  }'

JavaScript piemērs

// Build the inner query separately because the API expects it as a JSON-encoded string.
const searchQuery = JSON.stringify({
  keywords: "waterproof hiking boots"
});
 
const response = await fetch("https://api.shoplyai.ai/product_query_v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    store_key: "your-store.myshopify.com",
    query: searchQuery,
    start: 0,
    limit: 8
  })
});
 
if (!response.ok) {
  throw new Error(`Shoply search failed with status ${response.status}`);
}
 
const results = await response.json();
console.log(results.docs);

Python piemērs

import json
import requests
 
# The query value is encoded separately to match Shoply's structured search contract.
payload = {
    "store_key": "your-store.myshopify.com",
    "query": json.dumps({"keywords": "waterproof hiking boots"}),
    "start": 0,
    "limit": 8,
}
 
response = requests.post(
    "https://api.shoplyai.ai/product_query_v2",
    json=payload,
    timeout=30,
)
response.raise_for_status()
 
results = response.json()
print(results["docs"])

Atbilde

Veiksmīgs pieprasījums atgriež:

{
  "num_results": 2,
  "docs": [
    {
      "product_id": "gid://shopify/Product/1234567890",
      "url": "https://your-store.example/products/example-product",
      "product_name": "Example Product",
      "brand": "Example Brand",
      "current_price": "129.00",
      "currency": "USD",
      "main_image": "https://cdn.shopify.com/example-product.jpg",
      "selected_variant_id": "gid://shopify/ProductVariant/1234567891"
    }
  ],
  "display_filters": []
}

• num_results ir kopējais atbilstošo produktu skaits.
• docs satur sarindotos produktus pieprasītajai lapai.
• display_filters satur pieejamos filtrus, piemēram, cenu, zīmolu, krāsu vai citus katalogam specifiskus atribūtus.

Produktu objekti var saturēt papildu laukus atkarībā no veikala kataloga, variantiem, cenām un Shoply konfigurācijas. Klientiem jāizmanto tie lauki, kas tiem nepieciešami, un droši jāignorē nepazīstamie lauki.

Lappušošana

Izmantojiet start un limit, lai pieprasītu papildu rezultātus. Piemēram, pēc astoņu produktu pieprasīšanas ar start: 0 un limit: 8, pieprasiet nākamo lapu ar:

{
  "start": 8,
  "limit": 8
}

Apstājieties, kad start + docs.length ir lielāks vai vienāds ar num_results, vai kad docs ir tukšs.

Piezīmes par plānu un integrāciju

Ja jūsu pielāgotajam veikala skatlogam arī nepieciešama saruna, pievienojiet čatu headless Shopify veikala skatlogam.

• Standarta API meklēšana ir pašapkalpošanās un neprasa vietnē esošo logrīku.
• Jūsu Shopify veikalam jāpaliek savienotam ar Shoply AI, lai tā produktu indekss varētu palikt aktuāls.
• API meklējumi un veikala skatloga meklējumi koplieto ikmēneša meklēšanas limitu jūsu Shopify plānā.
• Saglabājiet izsaukumu savā backend, ja vēlaties centralizēt kešošanu, žurnalēšanu, atkārtotus mēģinājumus vai piekļuves kontroli.
• Sazinieties ar mums par Enterprise atbalstu, ja jums nepieciešama pielāgota autentifikācija, garantēta caurlaidspēja, SLA, katalogs ārpus Shopify vai limiti, kas pārsniedz publicētos plānus.

Lai saņemtu palīdzību veikala atslēgas apstiprināšanā vai plānojot produkcijas integrāciju, sazinieties ar Shoply AI.