วิธีใช้ Shoply AI Search API

ได้ คุณสามารถส่งคำขอไปยัง Shoply AI Search แบบเป็นโปรแกรมจากแบ็กเอนด์ของคุณเองได้ โดยไม่ต้องโหลดวิดเจ็ตบนหน้าเว็บหรือส่งคำขอผ่าน Shopify storefront ของคุณ

API สำหรับการค้นหามาตรฐานพร้อมใช้งานในทุก แผน Shopify ที่รวม AI Search รวมถึง Forever Free คำขอ API จะใช้โควต้าการค้นหารายเดือนเดียวกันกับการค้นหาที่ทำผ่านวิดเจ็ตบน storefront ดูขีดจำกัดปัจจุบันได้ที่หน้าราคา

หากคุณต้องการขีดจำกัดที่สูงขึ้น ข้อตกลงระดับการให้บริการ แหล่งข้อมูลแบบกำหนดเอง หรือการเชื่อมต่อที่ไม่ได้ใช้แคตตาล็อก Shopify ที่ Shoply ทำดัชนีไว้ ติดต่อเราเกี่ยวกับแผน Enterprise

ก่อนเริ่มต้น

ติดตั้ง Shoply AI บนร้านค้า Shopify ที่มีแคตตาล็อกที่คุณต้องการค้นหา และรอให้การทำดัชนีสินค้าเริ่มต้นเสร็จสิ้น คุณจะต้องใช้โดเมน myshopify.com ถาวรของร้านค้า เช่น:

your-store.myshopify.com

API นี้สามารถเรียกใช้ได้จากสภาพแวดล้อมแบ็กเอนด์ใดก็ได้ ไม่จำเป็นต้องมี API key แยกต่างหากสำหรับ endpoint การค้นหาสินค้ามาตรฐาน เพราะ endpoint นี้ส่งคืนข้อมูลแคตตาล็อกสาธารณะเดียวกันกับที่ Shoply สามารถแสดงในประสบการณ์การค้นหาบน storefront ได้

Endpoint

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

Request Body

query เป็นสตริง JSON ภายใน request body ไม่ใช่อ็อบเจ็กต์ JSON แบบซ้อน ตัวอย่างเช่น วลีค้นหา waterproof hiking boots จะถูกส่งเป็น:

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

ตัวอย่าง cURL

แทนที่ your-store.myshopify.com ด้วยโดเมน Shopify ถาวรของร้านค้าคุณ:

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

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

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

การตอบกลับ

คำขอที่สำเร็จจะส่งคืน:

{
  "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 คือจำนวนสินค้าที่ตรงกันทั้งหมด
• docs มีสินค้าที่ถูกจัดอันดับสำหรับหน้าที่ร้องขอ
• display_filters มีตัวกรองที่ใช้งานได้ เช่น ราคา แบรนด์ สี หรือคุณลักษณะเฉพาะอื่น ๆ ของแคตตาล็อก

อ็อบเจ็กต์สินค้าอาจมีฟิลด์เพิ่มเติมได้ ขึ้นอยู่กับแคตตาล็อกของร้านค้า ตัวแปรสินค้า ราคา และการตั้งค่า Shoply ไคลเอนต์ควรใช้ฟิลด์ที่ต้องการ และละเว้นฟิลด์ที่ไม่คุ้นเคยได้อย่างปลอดภัย

การแบ่งหน้า

ใช้ start และ limit เพื่อขอผลลัพธ์เพิ่มเติม ตัวอย่างเช่น หลังจากขอสินค้าแปดรายการด้วย start: 0 และ limit: 8 ให้ขอหน้าถัดไปด้วย:

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

ให้หยุดเมื่อ start + docs.length มากกว่าหรือเท่ากับ num_results หรือเมื่อ docs ว่างเปล่า

หมายเหตุเกี่ยวกับแผนและการเชื่อมต่อ

หาก storefront แบบกำหนดเองของคุณต้องการความสามารถด้านบทสนทนาด้วย เพิ่มแชตให้กับ headless Shopify storefront

• การค้นหา API มาตรฐานเป็นแบบบริการตนเองและไม่จำเป็นต้องใช้วิดเจ็ตบนหน้าเว็บ
• ร้านค้า Shopify ของคุณต้องยังคงเชื่อมต่อกับ Shoply AI เพื่อให้ดัชนีสินค้ายังคงอัปเดตอยู่เสมอ
• การค้นหาผ่าน API และการค้นหาบน storefront ใช้โควต้าการค้นหารายเดือนร่วมกันตามแผน Shopify ของคุณ
• เก็บการเรียกใช้งานไว้ที่แบ็กเอนด์ของคุณ หากคุณต้องการรวมศูนย์การแคช การบันทึกล็อก การลองใหม่ หรือการควบคุมการเข้าถึง
• ติดต่อเราสำหรับการรองรับระดับ Enterprise หากคุณต้องการการยืนยันตัวตนแบบกำหนดเอง ปริมาณงานที่รับประกัน SLA แคตตาล็อกที่ไม่ใช่ Shopify หรือขีดจำกัดที่สูงกว่าแผนที่เผยแพร่ไว้

หากต้องการความช่วยเหลือในการยืนยัน store key ของคุณหรือวางแผนการเชื่อมต่อสำหรับใช้งานจริง ติดต่อ Shoply AI