REST API v1.4.0 · HTTPS JSON

واجهة برمجية مصممة لبناء وتوسيع عمليات الشحن

أتمت كل خطوة في سلسلة الإمداد: إنشاء البوالص، الاستعلام عن الأسعار، تتبع الشحنات، واستقبال إشعارات الويب هوك اللحظية.

فهرس الواجهات البرمجية

المصادقة (Authentication)
إنشاء شحنة (Create Shipment)
تتبع الشحنة (Track Shipment)
حساب التعرفة (Calculate Rate)
إشعارات الويب هوك (Webhooks)
طلب مفاتيح الربط (Get API Keys)

الأمان والمصادقة

المصادقة عبر Bearer Token

يتم مصادقة كافة الطلبات عبر ترويسة HTTP Authorization القياسية باستخدام مفتاح API الخاص بمتجرك:

Authorization: Bearer sec_live_89f02c9184a1e948

POST /api/v1/shipments

إنشاء بوليصة شحن جديدة

ينشئ هذا المسار بوليصة شحن فورية ويعيد كود التتبع ورابط ملصق الطباعة الحراري (PDF/ZPL).

مثال لطلب JSON (Request Body):

{
  "pickup_city": "Cairo",
  "delivery_city": "Alexandria",
  "service": "express",
  "weight_kg": 2.5,
  "cod_amount": 1250.00,
  "sender": {
    "name": "Ahmed Mansour",
    "phone": "+201012345678",
    "address": "Fifth Settlement, Cairo"
  },
  "receiver": {
    "name": "Mahmoud Khaled",
    "phone": "+201234567890",
    "address": "Smouha, Alexandria"
  }
}

الاستجابة الناجحة (Response 201 Created):

{
  "success": true,
  "shipment_code": "EGY-CAI-984210",
  "status": "pending_pickup",
  "estimated_delivery": "2026-10-16T16:00:00Z",
  "label_url": "https://api.manifest.local/v1/labels/EGY-CAI-984210.pdf"
}

GET /api/v1/track/{shipment_code}

الاستعلام عن حالة شحنة وموقعها

يعيد المسار الحالي للشحنة وسجل كافة المحطات والتاريخ المتوقع للتسليم.

إشعارات الأحداث التلقائية

إشعارات الويب هوك اللحظية (Webhooks)

نرسل إشعارات POST إلى الخادم الخاص بك فور تغير حالة الشحنة (مثال: `shipment.out_for_delivery` أو `shipment.delivered` أو `shipment.returned`).

طلب مفاتيح بيئة الاختبار والإنتاج (Request API Access)

املأ النموذج أدناه لتفعيل حساب المطورين وإرسال مفاتيح الاختبار (Sandbox Keys) فوراً إلى بريدك.