توثيق المطورين في DZBuild
DZBuild (dzbuild.com) هي منصة التجارة الإلكترونية للتجار في الجزائر: متاجر إلكترونية بالدفع عند الاستلام، وتوصيل عبر شركات التوصيل إلى الولايات، وصفحات هبوط، ورسائل WhatsApp للطلبات. تطبيق DZBuild خدمة تشغّلها على خوادمك أنت. يثبّته صاحب المتجر، فيقرأ خادمك بيانات ذلك المتجر ويعدّلها عبر واجهة REST. لا يُشغَّل أي جزء من شيفرتك على DZBuild.
مثلاً، يتيح تطبيق تصدير الكتالوج للتاجر تنزيل منتجاته في ملف CSV. يثبّت التاجر التطبيق، ويقرأ خادمك منتجات متجره بالصلاحيات الممنوحة، ثم يُعدّ تطبيقك ملف التصدير. يوفّر القالب cloudflare-catalog هذا المثال.
اختر نقطة البداية
| تريد أن | ابدأ من هنا |
|---|---|
| تبني أول تطبيق لك وتجرّبه | اختر قالباً، ثم اتبع دليل البدء لتسجيل التطبيق وتثبيته. |
| تعمل مع وكيل برمجة | اربط وكيلك، ثم اتبع دليل التطوير بالذكاء الاصطناعي. يمنحه الربط وصولاً للقراءة فقط إلى التوثيق. |
| تجد عملية برمجية أو صلاحياتها | راجع مرجع الواجهة البرمجية والصلاحيات. |
ما تقدّمه المنصة
| العنصر | ما يمنحه لتطبيقك |
|---|---|
| التطبيقات | تسجّل تطبيقك في منصة المطورين، فيحصل على client_id وسرّ العميل ومفتاح التوقيع. |
| مسار التثبيت | يوافق صاحب المتجر على تطبيقك في شاشة الموافقة. المسار هو OAuth 2.0 بنوع authorization code مع PKCE بطريقة S256. |
| رموز التثبيت | كل متجر يثبّت تطبيقك يحصل على رمز Bearer خاص به، محدود بالصلاحيات التي وافق عليها صاحب المتجر. |
| واجهة REST | يغطي https://api.dzbuild.app/v1 المتجر والمنتجات والطلبات والتوصيل والعملاء وصفحات الهبوط وأكواد التخفيض والبكسلات والشحن والإحصائيات وWhatsApp. |
إشعارات webhook | ترسل DZBuild أحداث الطلبات والحدث app.uninstalled إلى رابطك، موقّعة بالترويسة X-DZ-Signature. |
واجهة WhatsApp | يرسل تطبيقك قوالب الطلبات المعتمدة على المنصة إلى المشترين. تُدفع كل رسالة من رصيد WhatsApp الخاص بالمتجر. |
| رابط الفتح | يوجّه زر الفتح في لوحة تحكم التاجر إلى تطبيقك مع رمز موقّع في dz_launch. |
| منصة المطورين | في https://dzbuild.com/dashboard/developer تسجّل تطبيقاتك وتجدّد أسرارها وتجرّبها على متجرك وترسلها للمراجعة. |
لمن هذا التوثيق
هذه الصفحات موجّهة للمطورين الذين يبنون أدوات يثبّتها تجار DZBuild من لوحة تحكمهم. يستطيع أي حساب على DZBuild لديه متجر فتح منصة المطورين. ما دام التطبيق مسودة أو قيد المراجعة، فلا يُثبَّت إلا على المتاجر التي يملكها حساب المطور. بعد أن توافق عليه DZBuild، يستطيع أي صاحب متجر تثبيته مهما كانت خطته، إلا إذا حدّدتَ خطة دنيا.
توثيق التجار موجود في dzbuild.com/docs. وهو يشرح لوحة التحكم من جهة التاجر.
DZShip: واجهة شحن برمجية مجانية
DZShip واجهة برمجية مستضافة ومجانية، مستقلة عن واجهة التطبيقات، لإنشاء الطرود وتتبعها مع شركات التوصيل الجزائرية. لا تحتاج إلى التسجيل في DZShip أو الحصول على مفتاح API منها: ترسل بيانات اعتماد حسابك لدى شركة التوصيل مع كل طلب. يتيح وضع sandbox تجربة الطلبات دون إنشاء طرود حقيقية. استخدام الواجهة مجاني، وتبقى رسوم التوصيل الخاصة بشركة التوصيل مستحقة.
راجع مستودع DZShip وتوثيق واجهته البرمجية لحقول الطلبات والأمثلة. تجد قوالب التطبيقات والمشاريع العامة الأخرى في DZBuild على GitHub.
الخطوة التالية
- البدء: سجّل تطبيقاً وثبّته على متجرك ونفّذ أول طلب إلى الواجهة البرمجية.
- المفاهيم الأساسية: التطبيقات والتثبيتات والمتاجر والخطط ووضع التجربة والحدّ الخاص بكل تثبيت ورموز التثبيت.
- OAuth: كل معاملات التفويض وتبادل الرمز، وكل رموز الأخطاء.
- الصلاحيات: ما تسمح به كل صلاحية.
- إشعارات webhook: الأحداث والتحقق من التوقيع.
- واجهة WhatsApp: إرسال قوالب الطلبات.
- حدود معدّل الطلبات: حصص الطلبات وإعادة المحاولة.
- مرجع الواجهة البرمجية: كل نقاط
/v1ووصفOpenAPI. - إرشادات المراجعة والأمان: ما تتحقق منه
DZBuildقبل قبول التطبيق. - سجل التغييرات: التغييرات المؤرّخة على المنصة.