العودة إلى التوثيق

مرجع API

توثيق كامل لواجهة REST API وأدوات MCP و webhooks في zalink.ai

الرابط الأساسي

https://api.zalink.ai

المصادقة

تتطلب جميع طلبات API المصادقة. أضف مفتاح API كرمز Bearer في رأس Authorization. لتدفقات OAuth، أعد توجيه المستخدمين إلى عنوان تفويض المنصة.

رمز Bearer

Authorization: Bearer YOUR_API_KEY

تدفق OAuth 2.0

  1. 1.إعادة التوجيه إلى /oauth/connect/:platform مع معلمة state
  2. 2.المستخدم يفوّض على المنصة
  3. 3.استلام callback على /oauth/callback/:platform
  4. 4.تخزين الرموز وتشفيرها على الخادم

أمثلة الكود

curl -X GET "https://api.zalink.ai/api/stores/STORE_ID/products?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

نقاط نهاية REST

المتجر

GET
/api/stores/:id

الحصول على تفاصيل المتجر وحالة الاتصال

PUT
/api/stores/:id/settings

تحديث إعدادات المتجر (الأعمال، الشحن، الضرائب، AI)

المنتجات

GET
/api/stores/:id/products

قائمة المنتجات مع التصفح والفلاتر

GET
/api/stores/:id/products/:productId

الحصول على منتج واحد حسب المعرف

الطلبات

GET
/api/stores/:id/orders

قائمة الطلبات مع فلاتر التاريخ والحالة

GET
/api/stores/:id/orders/:orderId

تفاصيل الطلب بما في ذلك عناصر السطر

العملاء

GET
/api/stores/:id/customers

قائمة العملاء مع البحث والتصفح

GET
/api/stores/:id/customers/:customerId

ملف العميل وسجل الطلبات

السلة

POST
/api/stores/:id/cart

إنشاء سلة جديدة مع عناصر

PUT
/api/stores/:id/cart/:cartId

تحديث عناصر السلة أو تطبيق كوبونات

DELETE
/api/stores/:id/cart/:cartId

حذف سلة

التحليلات

GET
/api/stores/:id/analytics/realtime

الزوار الفوريون والسلات النشطة والإيرادات

GET
/api/stores/:id/analytics/daily

مقاييس المبيعات والحركة اليومية المجمعة

GET
/api/stores/:id/analytics/products

أفضل المنتجات حسب المشاهدات والمبيعات

GET
/api/stores/:id/analytics/customers

بيانات اكتساب العملاء والاحتفاظ بهم

GET
/api/stores/:id/analytics/ai

مقاييس تفاعل AI ومعدلات التحويل

العروض

GET
/api/stores/:id/promotions

قائمة جميع العروض

POST
/api/stores/:id/promotions

إنشاء عرض أو كوبون جديد

PUT
/api/stores/:id/promotions/:promoId

تحديث عرض موجود

DELETE
/api/stores/:id/promotions/:promoId

حذف عرض

أدوات MCP

أدوات بروتوكول سياق النموذج المتاحة لمساعدي الذكاء الاصطناعي مثل Claude.

search_productsget_productget_categoriescreate_cartadd_to_cartcheckoutget_order_statusget_store_policiesvalidate_couponget_active_promotions

واجهة API العامة (ACP)

نقاط نهاية بروتوكول التجارة الوكيلة لـ ChatGPT ووكلاء AI الآخرين.

GET
/acp/stores/:id

معلومات المتجر وقدراته

GET
/acp/stores/:id/products/search

البحث في المنتجات مع فلاتر

POST
/acp/stores/:id/cart

إنشاء سلة للدفع

POST
/acp/stores/:id/checkout

إنشاء رابط الدفع

أحداث Webhook

الأحداث المرسلة إلى عنوان webhook المسجل.

order.createdorder.updatedorder.completedorder.cancelledproduct.createdproduct.updatedproduct.deletedcustomer.createdcustomer.updatedapp.uninstalled

رموز الأخطاء

الرمزالاسمالوصف
400طلب سيءمعلمات أو جسم طلب غير صالح
401غير مصرحمفتاح API مفقود أو غير صالح
403ممنوعصلاحيات غير كافية لهذا المورد
404غير موجودالمورد غير موجود
429طلبات كثيرةتجاوز حد المعدل، أعد المحاولة بعد فترة
500خطأ الخادمخطأ داخلي، تواصل مع الدعم إذا استمر

حدود المعدل

الحدود مفروضة لكل مفتاح API. الرؤوس: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

النقطةالحد
واجهة لوحة التحكم100 طلب/دقيقة
نقاط OAuth20 طلب/دقيقة
نقاط MCP100 طلب/دقيقة
نقاط ACP100 طلب/دقيقة
معالجات Webhook200 طلب/دقيقة