واجهة Twendex Platform API
أدمج الخدمات اللوجستية في تطبيقك. المحرك نفسه الذي يشغّل Twendex — الشحنات والأسعار والتتبع وwebhooks — عبر واجهة REST.
ما الذي يمكنك بناؤه
تمنح واجهة Twendex Platform API تطبيقك وصولًا برمجيًا إلى محرك الخدمات اللوجستية نفسه الذي تستخدمه آلاف الشركات في أفريقيا. أنشئ شحنات، واحصل على أسعار فورية، وعيّن مزودي خدمة النقل، وتتبع عمليات التوصيل، واستقبل أحداث الويب هوك — كل ذلك عبر واجهة REST واحدة بإصدارات.
إنشاء الشحنات وإدارتها
أنشئ الشحنات برمجيًا، واطلب الأسعار، واقبل العروض، وعيّن مزودي خدمة النقل — بنفس سير العمل الموجود في واجهة Twendex.
ويب هوك فوري
استقبل أحداث ويب هوك موقّعة ومُعاد إرسالها لكل تغيّر في دورة حياة الشحنة: تم الإنشاء، تم التسعير، تم التعيين، قيد النقل، تم التسليم.
وصول محمي بالصلاحيات
مفاتيح الـ API محصورة بمواردك. الوصول بين الحسابات محجوب. وهناك حدود استخدام لكل مستوى.
إدارة ذاتية
أصدر مفاتيح API وبدّلها وألغِها من لوحتك. سجّل نقاط نهاية الويب هوك. راقب الاستخدام — دون موافقة يدوية.
تسجيل الدخول
# All API requests require an API key
curl -H "X-API-Key: twx_live_xxxxxxxxxxxx" \
https://api.twendex.com/api/v1/platform/shipments
# Or use Bearer token
curl -H "Authorization: Bearer twx_live_xxxxxxxxxxxx" \
https://api.twendex.com/api/v1/platform/shipmentsالعنوان الأساسي: https://api.twendex.com/api/v1
البدء السريع
احصل على مفتاح API
سجّل الدخول إلى حسابك في Twendex، وانتقل إلى لوحة المطورين، وأنشئ مفتاح API تجريبيًا. يُعرض سر المفتاح مرة واحدة فقط — انسخه فورًا.
أنشئ أول شحنة لك
أرسل طلب POST إلى /api/v1/platform/shipments مع مفتاح API في ترويسة X-API-Key. ضمّن تفاصيل الاستلام والتسليم والطرد في جسم الطلب.
احصل على الأسعار وعيّن مزود خدمة نقل
استعلم عن GET /api/v1/platform/shipments/{id}/quotes لرؤية عروض مزودي خدمة النقل. اقبل عرضًا بإرسال طلب إلى نقطة نهاية تعيين مزود الخدمة.
تتبّع واستقبل الويب هوك
استخدم GET /api/v1/platform/tracking/{shipmentId} لمعرفة الموقع الفوري. سجّل نقطة نهاية ويب هوك لاستقبال الأحداث تلقائيًا عند كل تغيّر في الحالة وحتى إثبات التسليم.
بيئة الاختبار / وضع التجربة
تتيح لك مفاتيح بيئة الاختبار تجربة سير العمل الكامل دون المساس بمزودي خدمة نقل حقيقيين أو أموال أو عمليات إرسال. شحنات وضع التجربة معزولة عن البيانات الحقيقية.
- أنشئ مفتاح اختبار من لوحة المطورين (اضبط البيئة على 'sandbox' عند الإنشاء).
- كل شحنات التجربة تبقى في وضع الاختبار — لا يُرسل ناقل حقيقي ولا تُنفَّذ مدفوعات حقيقية.
- استخدم نفس نقاط النهاية وسير العمل كما في الإنتاج. بدّل إلى مفتاح حقيقي عندما تكون جاهزًا للانطلاق.
توثيق API التفاعلي
استكشف كل نقطة نهاية، واطّلع على مخططات الطلب والاستجابة، وجرّب الطلبات مباشرة من متصفحك عبر توثيق Swagger المباشر.
افتح توثيق APIلديك حساب؟ أدر مفاتيحك وwebhooks من لوحة التحكم.
اذهب إلى لوحة المطورين