مرجع واجهات الـ API

اربط نظامك الخاص بـ Delivery Syria. الواجهتان بصيغة JSON عبر HTTPS وتُوثَّقان بمفتاح API في ترويسة Bearer. يُعرض هذا المرجع من مستندات OpenAPI 3.1 التي تفحصها اختبارات آلية مقابل المسارات وقواعد التحقق والردود الفعلية.

واجهة التاجر في Delivery Syria

تسعير الطرود وإنشاؤها وعرضها وتتبّعها وإلغاؤها، وقراءة كشف المحفظة، وإدارة روابط الويب هوك.

المسار الأساسي: /api/v1
نقاط النهاية: 17
أحداث الويب هوك: 11

افتح المرجع تنزيل OpenAPI (JSON)

merchant-v1.json

واجهة شركة التوصيل في Delivery Syria

قراءة تجّارك ومناديبك وطرودك، وإنشاء طرود لتجّارك، وتعيين المناديب، وتحديث الحالات.

المسار الأساسي: /api/company/v1
نقاط النهاية: 8
أحداث الويب هوك: 8

افتح المرجع تنزيل OpenAPI (JSON)

company-v1.json

قبل أن تبدأ

أرسل مفتاح الـ API في ترويسة Authorization: Bearer. ولا تُقرأ أي طريقة أخرى لإرساله.
كل ردّ بصيغة JSON وبغلاف واحد: success مع data (وmeta في القوائم المرقّمة)، أو خطأ مع code.
الطلبات محدودة لكل عنوان IP وبحسب باقتك؛ وردّ 429 يطلب منك الانتظار.
الإصدار هو المسار (/api/v1 و/api/company/v1). لا توجد ترويسة للإصدار ولا Idempotency-Key: استخدم reference الطرد لإعادة المحاولة بأمان.

الاستيراد في Postman أو Insomnia

نزّل مستند OpenAPI 3.1 لإحدى الواجهتين واستورده، أو أعطِ الأداة عنوان المستند. يصف الملف مسارات نسبية إلى /api/v1 أو /api/company/v1، فاضبط العنوان الأساسي على عنوان منصتك بعد الاستيراد. وتستخدم الأمثلة قيماً بديلة فقط (YOUR_DOMAIN وYOUR_API_KEY): لا تلصق مفتاحاً حقيقياً في مجموعة مشتركة.

لا توجد لوحة «جرّب الآن»

لا يتضمن هذا المرجع لوحة «جرّب الآن» ولا يرسل أي طلب من متصفحك. فذلك يعني إدخال مفتاح API حقيقي في صفحة ويب واستدعاء الواجهة الفعلية ببيانات حقيقية. اختبر بالأمثلة البرمجية ومفتاحك الخاص من خادمك أو من الطرفية.

ولا توجد مكتبات عميل (SDK) مولَّدة أيضاً: مستندات OpenAPI تصف الواجهة، ويمكنك استخدام أي مولِّد تثق به معها.