Conas an Shoply AI Search API a Úsáid

Shoply AI Search API connecting backend code to storefront product search results

Sea. Is féidir leat Shoply AI Search a cheistiú go ríomhchláraithe ó do chúltaca féin gan an ghiuirléid ar an suíomh a luchtú ná an t-iarratas a sheoladh trí d’éadan siopa Shopify.

Tá an API cuardaigh caighdeánach ar fáil le gach plean Shopify a chuimsíonn AI Search, lena n-áirítear Forever Free. Úsáideann iarratais API an liúntas cuardaigh míosúil céanna agus a úsáideann cuardaigh a dhéantar tríd an ngiuirléid éadain siopa. Féach na teorainneacha reatha ar ár leathanach praghsála.

Má theastaíonn teorainneacha níos airde, comhaontú ar leibhéal seirbhíse, foinse sonraí saincheaptha, nó comhtháthú nach n-úsáideann catalóg Shopify atá innéacsaithe ag Shoply, déan teagmháil linn faoi phlean Enterprise.

Sula dTosaíonn Tú

Suiteáil Shoply AI ar an siopa Shopify a bhfuil tú ag iarraidh a chatalóg a chuardach agus lig don innéacsú tosaigh táirgí críochnú. Beidh fearann buan myshopify.com an tsiopa de dhíth ort, mar shampla:

text
your-store.myshopify.com

Is féidir an API a ghlaoch ó aon timpeallacht chúltaca. Níl eochair API ar leith ag teastáil don chríochphointe caighdeánach cuardaigh táirgí toisc go bhfilleann sé an fhaisnéis chéanna faoi chatalóg phoiblí is féidir le Shoply a thaispeáint san eispéireas cuardaigh ar éadan an tsiopa.

Críochphointe

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

Corp an Iarratais

RéimseRiachtanachCur síos
store_keyTáFearann buan myshopify.com do shiopa
queryTáTeaghrán JSON-ionchódaithe ina bhfuil réimse keywords ar a laghad
startNílFritháireamh torthaí bunaithe ar nialas le haghaidh leathanaighnithe; is é 0 an réamhshocrú
limitNílUasmhéid na dtáirgí le filleadh; is é 4 an réamhshocrú

Is teaghrán JSON é query taobh istigh de chorp an iarratais, ní réad JSON neadaithe. Mar shampla, seoltar an frása cuardaigh waterproof hiking boots mar seo:

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

Sampla cURL

Cuir fearann buan Shopify do shiopa in áit your-store.myshopify.com:

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

Sampla JavaScript

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

Sampla Python

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

Freagra

Filleann iarratas rathúil:

json
{ "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": [] }
  • Is é num_results líon iomlán na dtáirgí comhoiriúnacha.
  • Tá na táirgí rangaithe don leathanach iarrtha in docs.
  • Tá scagairí atá ar fáil ar nós praghais, branda, datha, nó tréithe eile a bhaineann go sonrach leis an gcatalóg in display_filters.

Is féidir le réada táirge réimsí breise a bheith iontu ag brath ar chatalóg an tsiopa, leaganacha, praghsáil, agus cumraíocht Shoply. Ba cheart do chliaint na réimsí a theastaíonn uathu a úsáid agus neamhaird shábháilte a dhéanamh de réimsí nach bhfuil aithne acu orthu.

Leathanaighniú

Úsáid start agus limit chun torthaí breise a iarraidh. Mar shampla, tar éis ocht dtáirge a iarraidh le start: 0 agus limit: 8, iarr an chéad leathanach eile le:

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

Stop nuair atá start + docs.length níos mó ná nó cothrom le num_results, nó nuair atá docs folamh.

Nótaí faoi Phleananna agus Comhtháthú

Má tá comhrá de dhíth ar d’éadan siopa saincheaptha freisin, cuir comhrá le headless Shopify storefront.

  • Tá cuardach API caighdeánach féinseirbhíse agus ní éilíonn sé an ghiuirléid ar an suíomh.
  • Ní mór do do shiopa Shopify fanacht nasctha le Shoply AI ionas gur féidir a innéacs táirgí a choinneáil cothrom le dáta.
  • Roinneann cuardaigh API agus cuardaigh éadain siopa an liúntas cuardaigh míosúil do do phlean Shopify.
  • Coinnigh an glao ar do chúltaca más mian leat taisceadh, logáil, athiarrachtaí, nó rialú rochtana a lárnú.
  • Déan teagmháil linn le haghaidh tacaíochta Enterprise má theastaíonn fíordheimhniú saincheaptha, tréchur ráthaithe, SLA, catalóg nach catalóg Shopify í, nó teorainneacha níos faide ná na pleananna foilsithe.

Chun cabhair a fháil chun eochair do shiopa a dheimhniú nó comhtháthú táirgthe a phleanáil, déan teagmháil le Shoply AI.