Sut i Ddefnyddio API Chwilio AI Shoply

Ydy. Gallwch ymholi Chwilio AI Shoply yn rhaglennol o’ch backend eich hun heb lwytho’r teclyn ar y safle nac anfon y cais drwy eich blaen siop Shopify.

Mae’r API chwilio safonol ar gael gyda phob cynllun Shopify sy’n cynnwys AI Search, gan gynnwys Forever Free. Mae ceisiadau API yn defnyddio’r un lwfans chwilio misol â chwiliadau a wneir drwy declyn y blaen siop. Gweler y terfynau cyfredol ar ein tudalen brisio.

Os oes angen terfynau uwch arnoch, cytundeb lefel gwasanaeth, ffynhonnell ddata bwrpasol, neu integreiddiad nad yw’n defnyddio catalog Shopify wedi’i fynegeio gan Shoply, cysylltwch â ni ynghylch cynllun Enterprise.

Cyn Dechrau

Gosodwch Shoply AI ar y siop Shopify yr ydych am chwilio ei chatalog a gadewch i’r mynegai cynnyrch cychwynnol orffen. Bydd angen parth parhaol myshopify.com y siop arnoch, megis:

your-store.myshopify.com

Gellir galw’r API o unrhyw amgylchedd backend. Nid oes angen allwedd API ar wahân ar gyfer y pwynt terfyn chwilio cynnyrch safonol oherwydd ei fod yn dychwelyd yr un wybodaeth catalog gyhoeddus ag y gall Shoply ei dangos yn y profiad chwilio blaen siop.

Pwynt Terfyn

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

Corff y Cais

Mae query yn llinyn JSON y tu mewn i gorff y cais, nid yn wrthrych JSON nythol. Er enghraifft, anfonir yr ymadrodd chwilio waterproof hiking boots fel:

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

Enghraifft cURL

Disodlwch your-store.myshopify.com â pharth parhaol Shopify eich siop:

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
  }'

Enghraifft JavaScript

// 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);

Enghraifft Python

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"])

Ymateb

Mae cais llwyddiannus yn dychwelyd:

{
  "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 yw cyfanswm nifer y cynhyrchion sy’n cyfateb.
• Mae docs yn cynnwys y cynhyrchion wedi’u graddio ar gyfer y dudalen y gofynnwyd amdani.
• Mae display_filters yn cynnwys hidlyddion sydd ar gael megis pris, brand, lliw, neu briodoleddau eraill sy’n benodol i’r catalog.

Gall gwrthrychau cynnyrch gynnwys meysydd ychwanegol yn dibynnu ar gatalog y siop, amrywiadau, prisio, a chyfluniad Shoply. Dylai cleientiaid ddefnyddio’r meysydd sydd eu hangen arnynt ac anwybyddu meysydd anghyfarwydd yn ddiogel.

Tudalennu

Defnyddiwch start a limit i ofyn am ganlyniadau ychwanegol. Er enghraifft, ar ôl gofyn am wyth cynnyrch gyda start: 0 a limit: 8, gofynnwch am y dudalen nesaf gyda:

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

Stopiwch pan fo start + docs.length yn fwy na neu’n hafal i num_results, neu pan fo docs yn wag.

Nodiadau am Gynllun ac Integreiddio

Os oes angen sgwrsio hefyd ar eich blaen siop bwrpasol, ychwanegwch sgwrs at flaen siop Shopify headless.

• Mae chwilio API safonol yn hunanwasanaeth ac nid oes angen y teclyn ar y safle.
• Rhaid i’ch siop Shopify aros wedi’i chysylltu â Shoply AI fel y gall ei mynegai cynnyrch aros yn gyfredol.
• Mae chwiliadau API a chwiliadau blaen siop yn rhannu’r lwfans chwilio misol ar gyfer eich cynllun Shopify.
• Cadwch yr alwad ar eich backend os ydych am ganoli storio dros dro, cofnodi, ailgeisio, neu reoli mynediad.
• Cysylltwch â ni am gymorth Enterprise os oes angen dilysu personol, trwybwn gwarantedig, SLA, catalog nad yw’n Shopify, neu derfynau y tu hwnt i’r cynlluniau cyhoeddedig.

Am help i gadarnhau allwedd eich siop neu gynllunio integreiddiad cynhyrchu, cysylltwch â Shoply AI.