SPL Documentation - LIVE

## Sections
• [ابدأ الآن](https://portal.developers.gnteq.app/new-api-documentation-live-ar/get-started-1.md): تهدف وثيقة واجهة برمجة التطبيقات (API) هذه إلى مساعدتك في ربط أنظمتك وخدماتك الإلكترونية بمنصة سبل للشحن وتتبع الشحنات . ومن خلال استخدام واجهات برمجة التطبيقات هذه، ستتمكن من الحصول على المعلومات اللازمة لبدء عملية التكامل مع المنصة.
• [المصادقة](https://portal.developers.gnteq.app/new-api-documentation-live-ar/authentication-copy-1.md): لضمان الحفاظ على معايير عالية من الأمان وتوفير حماية إضافية للمستخدمين والحسابات، تستخدم خدمات واجهة برمجة التطبيقات (API) مزيجًا من التقنيات وبروتوكولات الأمان التي تفرض المصادقة. ويتعين على المستخدمين الحصول على رمز مفتاح (Token) يحتاج إلى التجديد بشكل دوري.
  • [الحصول على رمز](https://portal.developers.gnteq.app/new-api-documentation-live-ar/authentication-copy-1/get-tokens-oms.md): تُستخدم واجهة برمجة التطبيقات (API) هذه لمصادقة العميل وإنشاء رمز وصول (Access Token) مطلوب للوصول إلى واجهات برمجة التطبيقات المتاحة. ويجب تضمين رمز الوصول في طلبات واجهة برمجة التطبيقات اللاحقة لأغراض المصادقة. مدة صلاحية الرمز: يكون رمز الوصول الذي تم إنشاؤه صالحًا لمدة ساعة من وقت إصداره. وبمجرد انتهاء صلاحيته، يجب إنشاء رمز وصول جديد. رمز التحديث (Refresh Token): لا يتوفر رمز تحديث (Refresh Token)، لذلك يجب إنشاء رمز وصول جديد يدويًا في كل مرة تنتهي فيها صلاحية الرمز الحالي. التزامن (Concurrency): يؤدي طلب إنشاء رمز وصول جديد إلى إبطال رمز الوصول السابق.
• [الشحنات](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1.md): تتيح واجهات برمجة التطبيقات (APIs) هذه للمستخدمين المصرّح لهم ما يلي: إنشاء شحنة واحدة أو عدة شحنات على منصة سبل . تتبع الشحنات باستخدام رقم بوليصة الشحن (AWB Number) أو الرقم المرجعي (Reference Number) .
  • [انشاء شحنة](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/create-shipment-oms.md): المتطلبات المسبقة قبل إنشاء شحنة، تأكد من توفر حساب نشط (Active Account) ، و رمز عميل صالح (Customer Code) ، و رمز فرع مسجل (Branch Code) ، و رمز عنوان فرع مسجل (Branch Address Code) . تُعد هذه البيانات ضرورية لإنشاء الشحنة بنجاح، ويمكن الحصول عليها من خلال إجراءات التسجيل الأولي (Onboarding) أو إعداد الحساب ذات الصلة. التكرار يؤدي إرسال طلب مطابق للطلب السابق إلى إنشاء شحنة مكررة برقم بوليصة شحن (Waybill Number) جديد. يتم تطبيق آلية Idempotency على رقم AWB فقط، ولا يتم تطبيقها على الأرقام المرجعية (Reference Numbers) . يمكنني أيضًا توحيد صياغة قسم API Documentation بالكامل بنفس الأسلوب والمصطلحات.
  • [شحنات - الإلتقاط](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/shhnat-aliltqat.md): المتطلبات المسبقة قبل إنشاء شحنة، تأكد من توفر حساب نشط (Active Account) ، و رمز عميل صالح (Customer Code) ، و رمز فرع مسجل (Branch Code) ، و رمز عنوان فرع مسجل (Branch Address Code) . تُعد هذه البيانات ضرورية لإنشاء الشحنة بنجاح، ويمكن الحصول عليها من خلال إجراءات التسجيل الأولي (Onboarding) أو إعداد الحساب ذات الصلة. التكرار يؤدي إرسال طلب مطابق للطلب السابق إلى إنشاء شحنة مكررة برقم بوليصة شحن (Waybill Number) جديد. يتم تطبيق آلية Idempotency على رقم AWB فقط، ولا يتم تطبيقها على الأرقام المرجعية (Reference Numbers) . يمكنني أيضًا توحيد صياغة قسم API Documentation بالكامل بنفس الأسلوب والمصطلحات.
  • [شحنات - التسليم](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/shhnat-altslym.md): المتطلبات المسبقة قبل إنشاء شحنة، تأكد من توفر حساب نشط (Active Account) ، و رمز عميل صالح (Customer Code) ، و رمز فرع مسجل (Branch Code) ، و رمز عنوان فرع مسجل (Branch Address Code) . تُعد هذه البيانات ضرورية لإنشاء الشحنة بنجاح، ويمكن الحصول عليها من خلال إجراءات التسجيل الأولي (Onboarding) أو إعداد الحساب ذات الصلة. التكرار يؤدي إرسال طلب مطابق للطلب السابق إلى إنشاء شحنة مكررة برقم بوليصة شحن (Waybill Number) جديد. يتم تطبيق آلية Idempotency على رقم AWB فقط، ولا يتم تطبيقها على الأرقام المرجعية (Reference Numbers) . التسليم في أقرب مكتب SPL أو موقع طرود (Drop-Off):
  • [تتبع شحنة](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/shipment-tracking.md)
    • [تتبع الأحداث](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/shipment-tracking/ttba-alahdath.md): يقدم هذا القسم قائمة شاملة بأحداث التتبع التي قد تُرجعها واجهة برمجة التطبيقات (Tracking API) . يتكون كل حدث من رمز الحدث (Event Code) و وصف الحدث (Event Description) ، ويمثل حالة محددة للشحنة، أو مرحلة تشغيلية رئيسية، أو حالة استثنائية يتم مواجهتها خلال دورة حياة الشحنة. تم تصنيف هذه الأحداث لتسهيل عملية التكامل، وربط الحالات (Status Mapping)، وتنفيذ إجراءات وعمليات الأعمال بشكل أكثر سهولة. 1.معالجة الشحنة ومرحلة النقل Title Description Tracking Event Code Tracking Event Name GN019 New Shipment Created GN007 Shipment Inbound Scanned GN023 Shipment Arrived GN030 Shipment Forwarded GN046 Out of sorting centre GN065 Under Distribution GN074 Handover to supervisor 2. أحداث التسليم Title Description Tracking Event Code Tracking event Name GN011 Shipment out for delivery GN012 Shipment Delivered 3. أحداث الإستلام والتحصيل Title Description Tracking Event Code Tracking event Name GN033 Held for Pickup GN184 Shipment is available for customer pickup GN192 Your shipment is ready for pickup 4. أحداث الجمارك و التخليص الجمركي Title Description Tracking Event Code Tracking event Name GN008 Shipment Under Clearance GN100 ReleaseShipment GN124 Customs Clearance en 5. استثناءات التسليم Title Description Tracking Event Code Tracking event Name GN013 Shipment delivery exception GNS003 Courier route overload GNS010 Pending Better Address Details GNS034 Incorrect address - address not found GNS060 The customer did not answer the call GNS061 The customer's phone line is busy GNS062 The customer declined the call GNS084 Consignee requested future delivery GNS085 Phone number is incorrect GNS143 Address Correction GNS037 Refused - due 'other' GNS043 Reschedule to another date 6. المرتجعات والإلغاءات Title Description Tracking Event Code Tracking event Name GN031 Returned to Shipper GN089 Return to Office GN101 ShipmentCancelation 7. الإشعارات والتواصل مع العملاء Title Description Tracking Event Code Tracking event Name GN015 Text notification sent GNS063 Customer call connected 8. تحديثات الشحنات والتعديلات Title Description Tracking Event Code Tracking event Name GN104 Shipment Reweight GN105 Shipment Address Updated 9. الأحداث الحرجة Title Description Tracking Event Code Tracking event Name GN018 Shipment Lost
  • [تتبع الشحنات المتعددة](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/ttba-alshhnat-almtaddh.md)
  • [طباعة ملصق](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/label-print.md)
  • [إلغاء الشحنة](https://portal.developers.gnteq.app/new-api-documentation-live-ar/shipments-copy-1/shipment-tracking-ttba-shhnh-copy.md)
• [ويب هوك](https://portal.developers.gnteq.app/new-api-documentation-live-ar/wyb-hwk.md): لإعداد ويب هوك ، يرجى ملاحظة ما يلي: المصادقة : سيتم إرسال أحداث الـ ويب هوك باستخدام إحدى طريقتي Basic Authorization أو X-API-Key ، مع استخدام بيانات اعتماد من اختياركم. بيانات الطلب : تم توضيح هيكل بيانات الطلب أدناه. يرجى التأكد من أن نقطة النهاية الخاصة بكم قادرة على استقبال هذا الهيكل. الأحداث : تم إدراج قائمة بأكثر الأحداث شيوعًا التي يتم إرسالها ضمن تبويب للرجوع إليها واستخدامها في عملية الربط. نقطة نهاية الـويب هوك: يتعين عليكم تزويدنا بعنوان نقطة نهاية الويب هوك الخاص بكم حتى نتمكن من تهيئته وربطه بحسابكم. ملاحظة: يجب أن تُرجع واجهة برمجة التطبيقات (API) استجابة منظمة حتى نتمكن من التحقق مما إذا كانت عملية التحديث قد تمت بنجاح. ويكون نموذج الاستجابة المتوقع كما يلي: public class DynamicTrackingShipmentResponse { public bool IsSuccess { get; set; } public string? Exception { get; set; } } بدون هذه الاستجابة، لن يتمكن نظامنا من التحقق مما إذا كان طلب الـويب هوك قد تم قبوله بنجاح أو فشل. يرجى التأكد من تنفيذ الاستجابة وفقًا للنموذج المطلوب. بيانات طلب الويب هوك يرجى التأكد من أن نقطة النهاية الخاصة بكم قادرة على استقبال هذا الهيكل. يرجى ملاحظة أن بيانات طلب الويب هوك لدينا تستخدم تنسيق وهي ؛Camel Case , غير حساسة لحالة الأحرف لذلك يرجى التأكد من أن الويب هوك الخاص بكم لا يعتمد على حالة الأحرف وأنه قادر على استقبال البيانات بأي من التنسيقين (Camel Case أو Pascal Case) مع الحفاظ على مرونة النظام في حال إضافة أي حقول جديدة من جانبنا مستقبلآ. Plain text { "airwaybill": "***************", "eventCode": "GN012", "event": "Shipment Delivered", "eventName": "Shipment Delivered", "supplier": null, "userName": "admin", "notes": null, "actionDate": "2024-10-29T17:30:00+00:00", "eventCountry": "AMMAN", "eventCity": "AMMAN", "eventSubCode": null, "eventSubName": null } { "airwaybill": "***************", "eventCode": "GN012", "event": "Shipment Delivered", "eventName": "Shipment Delivered", "supplier": null, "userName": "admin", "notes": null, "actionDate": "2024-10-29T17:30:00+00:00", "eventCountry": "AMMAN", "eventCity": "AMMAN", "eventSubCode": null, "eventSubName": null }