المتاجر · توثيق الـ API
البداية

مقدمة

أهلاً بيك في API المتاجر — واجهة REST اللي ورا كل متجر على منصة المتاجر. تقدر بيها تقرا وتعدّل الطلبات والمنتجات والأقسام والعملاء ومناطق الشحن، وتستقبل ويب هوك أول ما يحصل حاجة في المتجر.

تقدر تبني إيه

  • أدوات الطلبات — تبعت الطلبات لشركة شحن أو مخزن، تغيّر حالتها، تضيف ملاحظات.
  • تطبيقات المورّدين والدروبشيبينج — تضيف منتجات، تزامن المخزون بالـ SKU، وتستقبل الطلبات اللي فيها منتجاتك.
  • تطبيقات واتساب والرسايل — تأكيد الطلبات، تحديثات الشحن، تذكير السلات المتروكة.
  • ربط المحاسبة وأنظمة الـ ERP والتقارير وأي حاجة بتشتغل على بيانات المتجر.

إزاي تبدأ

  1. هات مفتاح — صاحب المتجر بيعمله من لوحته: النطاقات والتطبيقات ← الـ API العام (المصادقة). ولو تطبيقك لمتاجر كتير استخدم رابط التثبيت.
  2. نادِ الـ API — ابعت المفتاح في هيدر Api-Key على https://elmatajer.com/api/v1/vendor.
  3. استقبل الويب هوك — ضيف رابط ويب هوك للمفتاح وهيوصلك order.created موقّع (الويب هوك).
curl https://elmatajer.com/api/v1/vendor/orders?limit=5 \
  -H "Api-Key: YOUR_API_KEY"

قواعد عامة

  • JSON داخل وخارج. ابعت Accept: application/json.
  • كل رد فيه status (ok أو error)؛ البيانات في data والصفحات في meta.
  • الوقت بصيغة ISO 8601 بتوقيت المتجر، والفلوس رقم بعملة المتجر (currency_code).
  • الحد: 60 طلب في الدقيقة لكل مفتاح (حدود الطلبات).