التوثيق
ابنِ فوقمتجرك الخاص
واجهة REST API فوق البيانات نفسها التي تستخدمها لوحة التحكم: المنتجات والمخزون والطلبات والعملاء والمدفوعات، مع webhooks عند حدوث أي تغيير.
معاينة
المرجع الكامل غير متاح للعامة بعد. ما يلي دقيق بشأن واجهة API الموجودة اليوم، ويُمنح الوصول لكل متجر عند الطلب.
البدء
ثلاثة أمور قبل طلبك الأول
أنشئ متجرًا
تعمل واجهة API في نطاق متجر محدد. افتح متجرًا على الخطة المجانية إن لم يكن لديك واحد بعد.
أنشئ متجرًاأنشئ مفتاحًا
أنشئ مفتاحًا محدد النطاق من لوحة التحكم، ثم أرسله كرمز Bearer.
اطّلع على نموذج المصادقةطلبك الأول
كل استدعاء عبارة عن رمز Bearer ومسار ضمن نطاق المتجر. الاستجابات بصيغة JSON، ونقاط القوائم مقسّمة إلى صفحات.
عرض المفاتيح والنطاقات والحدودcurl https://api.securemarts.com/v1/products \
-H "Authorization: Bearer $SECUREMARTS_API_KEY" \
-H "Content-Type: application/json"التغطية
ما تصل إليه واجهة API
السجلات نفسها التي تقرؤها لوحة التحكم وتكتبها. لا شيء هنا نسخة منفصلة من بياناتك لأغراض التقارير.
الكتالوج والمخزون
اقرأ وعدّل المنتجات والمتغيرات والمجموعات ومستويات المخزون لكل فرع.
الطلبات وتجهيزها
اعرض الطلبات وحدّث حالتها وأرفق عمليات التوصيل وسجّل المرتجعات.
العملاء
سجلات العملاء وعناوينهم وسجل طلباتهم وانتماؤهم إلى الشرائح.
المدفوعات والفواتير
سجلات الدفع والفواتير والمبالغ المستردة والمستندات المرفقة بها.
Webhooks
اشترك في أحداث الطلبات والمخزون والمدفوعات والعملاء مع حمولات موقّعة.
بيانات المتجر الإلكتروني
بيانات كتالوج وسمة للقراءة فقط لبناء متجر إلكتروني مخصص.
أسئلة المطورين
لا. الوصول إلى API ميزة مرتبطة بالخطة ويُفعَّل لكل متجر. إذا كانت خطتك تشمله، يمكنك إنشاء المفاتيح من لوحة التحكم، وإلا فستجد طريقة الترقية في صفحة الأسعار.