ابدأ هنا
أنشئ متجرًا، واحصل على مفاتيحك، وأرسل منتجاتك، ونفّذ أول عملية بحث.
ما تحتاج إليه
- حساب في SeekGist. سجّل من لوحة التحكم على /app. وللتشغيل في متجرك اختر باقة وادفع؛ وقبل ذلك يمكنك الإعداد والتجربة.
- منتجات متجرك، سواء من منصة متاجر (OpenCart أو WooCommerce أو Shopify أو سلة أو زد أو Magento) أو من نظامك الخاص.
في لوحة التحكم معالج إعداد يرشدك خطوة بخطوة: اختر منصتك، ثبّت الإضافة، أنشئ الفهرس الأول، ثم نفّذ أول بحث. إذا كنت تستخدم منصة جاهزة فاتبع دليل البدء السريع الخاص بها بدلًا من الخطوات التالية. الخطوات التالية لمن يكتب الكود بنفسه. وهي تستخدم curl؛ وحزم التطوير لـJavaScript وPHP وPython ترسل الطلبات نفسها.
الخطوة 1: احصل على مفاتيحك
افتح صفحة مفاتيح API في لوحة التحكم. ستجد نوعين من المفاتيح:
| المفتاح | يبدأ بـ | استخدمه في | أين يمكن وضعه |
|---|---|---|---|
| المفتاح العام | sg_pub_ | الاقتراحات والبحث والتوصيات والنقرات والأحداث | المتصفح، وقالب المتجر، وأداة البحث |
| المفتاح السري | sg_sec_ | المنتجات والمرادفات والقواعد والترجمة والتحليلات وخطافات الويب | خادمك فقط |
الخطوة 2: أرسل منتجاتك
أرسل المنتجات على دفعات، حتى 1,000 منتج في كل طلب، باستخدام المفتاح السري. كل حقل نصي كائن يربط رمز اللغة بالنص، فيمكن أن يحمل المنتج الواحد اسمًا بالإنجليزية وآخر بالعربية.
curl -X POST https://api.seekgist.com/v1/products/batch \
-H "Authorization: Bearer $SEEKGIST_SECRET_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: first-import-001" \
-d '{
"upsert": [{
"id": "42",
"name": {"en": "Red Satin Evening Dress for Women, size M", "ar": "فستان سهرة نسائي من الساتان، أحمر، مقاس M"},
"brand": "Example Brand",
"price": "89.00",
"currency": "USD",
"in_stock": true,
"url": "https://shop.example/p/42",
"categories": [{"id": "20", "path": [{"en": "Women", "ar": "نسائي"}, {"en": "Dresses", "ar": "فساتين"}]}],
"attributes": {"Color": "Red", "Size": "M"}
}]
}'المنتج في المثال ليس حقيقيًا. يخبرك الرد بعدد المنتجات التي أُضيفت أو لم تتغير أو حُذفت. إذا أرسلت المنتج نفسه مرة أخرى دون تغيير فلن يحدث شيء ولن يُحتسب عليك. ولتبقى المنتجات محدّثة بعد هذا الإرسال الأول، اقرأ إبقاء المنتجات متزامنة.
الخطوة 3: ابحث
استخدم المفتاح العام. الاقتراحات أثناء الكتابة تأتي من /v1/suggest، ولا تُحتسب في الفاتورة أبدًا.
curl "https://api.seekgist.com/v1/suggest?q=dre" \
-H "Authorization: Bearer $SEEKGIST_PUBLIC_KEY"أما البحث الكامل (عندما يضغط المتسوق Enter) فيأتي من /v1/search:
curl --get "https://api.seekgist.com/v1/search" \
--data-urlencode "q=فستان سهرة تحت 100" \
--data-urlencode "session=$SHOPPER_SESSION_ID" \
-H "Authorization: Bearer $SEEKGIST_PUBLIC_KEY"أرسل session مع كل عملية بحث: رقم عشوائي لزيارة المتسوق، لا اسم ولا بريد إلكتروني. تُعدّ المرادفات المقترحة من عمليات البحث التي تحمله فقط.
يحتوي الرد على ids (أرقام المنتجات مرتبة حسب الصلة)، وhits (بطاقات المنتجات)، وfacets (عوامل التصفية)، وquery التي تبيّن ما فهمه SeekGist: في هذا الطلب، فستان سهرة، وحد أعلى للسعر 100.
الخطوة 4: أرسل النقرات
عندما ينقر المتسوق على نتيجة، أعد إرسال search_id الذي جاء في رد البحث. تساعد النقرات في التحليلات وفي تحسين الترتيب.
curl -X POST https://api.seekgist.com/v1/click \
-H "Authorization: Bearer $SEEKGIST_PUBLIC_KEY" \
-H "Content-Type: application/json" \
-d '{"search_id": "<from the search answer>", "product_id": "42", "position": 1}'الخطوات التالية
- إبقاء المنتجات متزامنة: كل تغيير، ومزامنة كاملة مرة في اليوم.
- أساسيات الواجهة البرمجية: الأخطاء وإعادة المحاولة الآمنة والاستخدام والحدود.
- دليل البحث بالعربية: ما الذي يفهمه SeekGist.
- مرجع الواجهة البرمجية: كل نقاط الوصول.
- حزم التطوير: JavaScript وPHP وPython.