Hvernig á að nota Shoply AI Search API

Já. Þú getur sent fyrirspurnir í Shoply AI Search með forritun frá þínum eigin bakenda án þess að hlaða inn græjunni á vefnum eða senda beiðnina í gegnum Shopify-verslunina þína.

Hefðbundna leitar-API-ið er í boði með öllum Shopify-áskriftarleiðum sem innihalda AI Search, þar á meðal Forever Free. API-beiðnir nota sama mánaðarlega leitarheimildarmagn og leitir í verslunargræjunni. Sjáðu gildandi takmörk á verðsíðunni okkar.

Ef þú þarft hærri mörk, þjónustustigssamning, sérsniðna gagnauppsprettu eða samþættingu sem notar ekki Shopify-vörulista sem Shoply hefur skráð, hafðu samband við okkur um Enterprise-áskriftarleið.

Áður en þú byrjar

Settu Shoply AI upp í Shopify-versluninni sem þú vilt leita í og leyfðu upphaflegri vöruskráningu að ljúka. Þú þarft varanlegt myshopify.com-lén verslunarinnar, til dæmis:

your-store.myshopify.com

Hægt er að kalla á API-ið úr hvaða bakendaumhverfi sem er. Ekki þarf sérstakan API-lykil fyrir hefðbundna vöruleitarendapunktinn, því hann skilar sömu opinberu upplýsingum úr vörulistanum og Shoply getur birt í leitarupplifun verslunarinnar.

Endapunktur

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

Beiðnismeginmál

query er JSON-strengur inni í meginmáli beiðninnar, ekki hreiðraður JSON-hlutur. Til dæmis er leitarsetningin waterproof hiking boots send svona:

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

cURL-dæmi

Skiptu your-store.myshopify.com út fyrir varanlegt Shopify-lén verslunarinnar þinnar:

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-dæmi

// 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-dæmi

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

Svar

Vel heppnuð beiðni skilar:

{
  "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 er heildarfjöldi vara sem passa við leitina.
• docs inniheldur raðaðar vörur fyrir umbeðna síðu.
• display_filters inniheldur tiltækar síur á borð við verð, vörumerki, lit eða aðra eiginleika sem ráðast af vörulistanum.

Vöruhlutir geta innihaldið fleiri reiti eftir vörulista verslunarinnar, vörutilbrigðum, verðlagningu og uppsetningu Shoply. Viðskiptavinir ættu að nota þá reiti sem þeir þurfa og hunsa óþekkta reiti á öruggan hátt.

Síðuskipting

Notaðu start og limit til að sækja fleiri niðurstöður. Til dæmis, eftir að hafa beðið um átta vörur með start: 0 og limit: 8, skaltu biðja um næstu síðu með:

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

Stöðvaðu þegar start + docs.length er stærra en eða jafnt og num_results, eða þegar docs er tómt.

Athugasemdir um áskriftarleið og samþættingu

Ef sérsmíðaða verslunarviðmótið þitt þarf líka samtöl geturðu bætt spjalli við headless Shopify-verslun.

• Hefðbundin API-leit er sjálfsafgreiðsla og krefst ekki græjunnar á vefnum.
• Shopify-verslunin þín verður að vera áfram tengd Shoply AI svo vöruskráin geti haldist uppfærð.
• API-leitir og leitir í versluninni deila mánaðarlegu leitarheimildarmagni Shopify-áskriftarleiðarinnar þinnar.
• Hafðu kallið á bakendanum þínum ef þú vilt miðlæga skyndiminnisvörslu, skráningu, endurtekningar eða aðgangsstýringu.
• Hafðu samband við okkur vegna Enterprise-aðstoðar ef þú þarft sérsniðna auðkenningu, tryggt afkastagetuþol, SLA, vörulista sem er ekki frá Shopify eða hærri mörk en birtar áskriftarleiðir bjóða.

Til að fá hjálp við að staðfesta verslunarlykilinn þinn eða skipuleggja samþættingu fyrir framleiðsluumhverfi skaltu hafa samband við Shoply AI.