واجهة برمجة التطبيقات API
بواسطة Supportمؤلف واحد35 مقالات
- واجهة DZBuild البرمجية — مقدمةابنِ على DZBuild — واجهة REST كاملة للمتاجر والمنتجات والطلبات والعملاء وصفحات الهبوط والاشتراكات وWebhooks.
- المصادقةتعلّم كيفية المصادقة على طلبات الواجهة البرمجية باستخدام مفاتيح المنصة والمفاتيح العامة، بما في ذلك Bearer tokens وتواقيع HMAC للوصول الآمن إلى DZBuild API.
- حدود المعدلشرح حدود المعدل في DZBuild API — وصول حصري لخطة Enterprise، والسقف لكل متجر في الدقيقة، وميزانيات النقاط المكلفة، ولماذا لا تمسّ هذه الحدود واجهة متجرك أو لوحتك.
- التكرار الآمن (Idempotency)كل طلب POST أو PATCH أو DELETE إلى DZBuild API يتطلب رأس Idempotency-Key ويقبله PUT أيضًا، فلا تُنفَّذ عملية الكتابة مرتين عند إعادة المحاولة بالمفتاح نفسه.
- الأخطاءمرجع كامل لأكواد الأخطاء وأكواد HTTP وصيغة استجابة الأخطاء في DZBuild API وكيفية التعامل معها في تطبيقك.
- التصفّح والترقيمتعرّف على كيفية استخدام DZBuild API للترقيم المعتمد على المؤشّر (cursor-based) في نقاط نهاية القوائم — جلب بيانات فعّال عبر next_cursor و has_more.
- المتجرGET /v1/store — ملف متجرك (الاسم، slug، الثيم، النطاق المخصص، الرابط العام).
- المنتجاتCRUD كامل لكتالوج المنتجات — قائمة، تفاصيل، إنشاء، تعديل، حذف. مع المتغيرات والصور وحدود الخطة.
- الطلباتإنشاء وقراءة الطلبات والانتقال بين حالاتها وإلغاؤها. دعم كامل للمتغيرات، سلال متعددة الأسطر، تسعير معتمد على الخادم.
- العملاءاقرأ قائمة عملائك، ابحث برقم الهاتف أو البريد، اعرض كل طلبات عميل واحد.
- صفحات الهبوطCRUD لصفحات الهبوط — صفحات تحويل لمنتج واحد بأقسام (سلايدرات، نماذج طلب، زوار وهميون، عدّاد تنازلي، عروض خاصة).
- المفاتيح (مفاتيحك الخاصة)أنشئ، اعرض، وألغِ مفاتيح الواجهة البرمجية لمتجرك. مفاتيح المنصة (Bearer) والمفاتيح العامة (HMAC).
- الاستخداماعرض استهلاك واجهتك البرمجية لهذا الشهر والتجميعات الساعية التاريخية.
- الحصصاعرض حدود خطة Enterprise، أي تجاوزات خاصة بمتجرك ضبطها الدعم، وحدودك الفعّالة.
- الاشتراكاتPOST /v1/signups — حسب اشتراك مستخدم نهائي ضمن حصتك الشهرية. الوحدة الرئيسية القابلة للقياس. موقّعة بـ HMAC، تُقبل بشكل غير متزامن، يُزال تكرارها بـ nonce + email.
- الأحداثPOST /v1/events — أحداث عامة يتتبعها التاجر (مشاهدات صفحة، عملاء محتملون، تحليلات مخصصة). نفس مخطط HMAC المستعمل في الاشتراكات، بدون إزالة تكرار email/phone.
- الثيمات والواجهات المخصصةابنِ واجهة متجر مخصصة بالكامل بـ React أو Vue أو Next.js أو Flutter — مدعومة بواجهة DZBuild البرمجية.
- للموزّعينكيف تستخدم DZBuild API لإعادة بيع المتاجر، إدارة العملاء على نطاق واسع، والتكامل مع back-office الخاص بك.
- إعداد البيئة و .envكيف تخزّن بيانات اعتماد DZBuild API بأمان في تطبيقك — من ملفات .env إلى KMS وحتى GitHub Secrets.
- نظرة عامة على Webhooksكيف تعمل webhooks في DZBuild — الأحداث التي تُطلق، آلية التسليم وإعادة المحاولة، نموذج الأمان، والحصص.
- تسجيل webhookأنشئ، اسرد، اختبر، واحذف اشتراكات webhook لمتجرك.
- كتالوج الأحداثكل أحداث webhook التي يمكن لـ DZBuild إطلاقها، مع شكل حقل البيانات لكل واحد بالضبط.
- التحقق من التواقيعكيفية مصادقة webhooks الواردة من DZBuild. مقارنة HMAC بزمن ثابت + فحص حداثة، مع كود جاهز للنسخ بـ Node.js و PHP و Python و Go.
- سجل التغييرات
- رسائل واتساباقرأ قوالب رسائل واتساب الخاصة بالطلبات ورصيد واتساب للمتجر وسجل الرسائل المرسلة، وأرسل قالباً معتمداً لزبون طلب معيّن من برنامجك الخاص.
- أقسام الصفحة الرئيسيةاقرأ أقسام الصفحة الرئيسية للمتجر وغيّرها من برنامجك الخاص بعشرة أنواع من الأقسام، فأضف قسماً أو عدّله أو أخفِه أو رتّب الأقسام أو احذفها أو تراجع عن تغيير.
- القوالباعرض قوالب واجهة المتجر وقوالب نموذج الطلب السريع وأنماط اختيار المتغيرات التي يستطيع المتجر استعمالها، ثم بدّل كل واحد منها من برنامجك الخاص.
- الفئاتاعرض فئات منتجات متجرك واقرأها وأنشئها وأعد تسميتها وانقلها واحذفها ورتّبها من برنامجك الخاص، ثم تراجع عن إعادة تسمية أو نقل أو حذف.
- الرموز الترويجيةاعرض الرموز الترويجية لمتجرك وأنشئها وعدّلها واحذفها من برنامجك الخاص، مع شرط تفعيل الإضافة وتأكيد خصم 100% والتراجع عن التغييرات.
- بيكسلات التتبعاعرض بيكسلات التتبع الخاصة بالمتجر وأضفها وعدّلها واحذفها من برنامجك، لمنصات Meta وTikTok وSnapchat وPinterest وGoogle. توكن الوصول يُكتب ولا يُقرأ.
- الشحناقرأ أسعار التوصيل لكل ولاية وقواعد الشحن المجاني وعدّلها، واربط شركات التوصيل واختبرها وزامن أسعارها، وتحقق من تغطيتها، واعرض قوائم الولايات والبلديات.
- الإحصائياتاقرأ أرقام لوحة التحكم لمتجر خلال فترة عبر GET /v1/analytics: الطلبات والإيرادات والربح والزوار ومعدل التحويل، مع نسبة التغيّر وبيانات الرسوم البيانية.
- التغييرات والتراجع عنهااعرض تغييرات الإعدادات التي أُجريت عبر الواجهة البرمجية، واقرأ أي تغيير مع القيم التي استبدلها، ثم تراجع عنه لتعود تلك القيم إلى المتجر.
- DZBuild POSكيف يرتبط برنامج الصندوق المجاني DZBuild POS على ويندوز بالمتجر، والنداءات التي يرسلها للمنتجات والصور والمخزون ووثائق البيع والطلبات والزبائن وتدفق الأحداث.
- اكتشاف الوكلاءأين يجد وكلاء الذكاء الاصطناعي والمساعدون ملفات DZBuild الآلية وموصّل MCP ووصف REST API وكتالوج كل متجر، والقواعد التي يتبعونها.