ابدأ الآن

المصادقة

الحصول على رمز

الشحنات

انشاء شحنة

شحنات - الإلتقاط

شحنات - التسليم

تتبع شحنة

تتبع الشحنات المتعددة

طباعة ملصق

إلغاء الشحنة

ويب هوك

New Collection 2162023

NEW API documentation - Live - AR

SPL Documentation - LIVE

Production

Sandbox

تهدف وثيقة واجهة برمجة التطبيقات (API) هذه إلى مساعدتك في ربط أنظمتك وخدماتك الإلكترونية بمنصة سبل للشحن وتتبع الشحنات. ومن خلال استخدام واجهات برمجة التطبيقات هذه، ستتمكن من الحصول على المعلومات اللازمة لبدء عملية التكامل مع المنصة.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

واجهة برمجة التطبيقات (API)

 هذه إلى مساعدتك في ربط أنظمتك وخدماتك الإلكترونية بمنصة 

سبل للشحن وتتبع الشحنات

. ومن خلال استخدام واجهات برمجة التطبيقات هذه، ستتمكن من الحصول على المعلومات اللازمة لبدء عملية التكامل مع المنصة.

لضمان الحفاظ على معايير عالية من الأمان وتوفير حماية إضافية للمستخدمين والحسابات، تستخدم خدمات واجهة برمجة التطبيقات (API) مزيجًا من التقنيات وبروتوكولات الأمان التي تفرض المصادقة. ويتعين على المستخدمين الحصول على رمز مفتاح (Token) يحتاج إلى التجديد بشكل دوري.

لضمان الحفاظ على معايير عالية من الأمان وتوفير حماية إضافية للمستخدمين والحسابات، تستخدم خدمات واجهة برمجة التطبيقات (API) مزيجًا من التقنيات وبروتوكولات الأمان التي تفرض المصادقة. ويتعين على المستخدمين الحصول على رمز مفتاح (Token) يحتاج إلى التجديد بشكل دوري.

تُستخدم واجهة برمجة التطبيقات (API) هذه لمصادقة العميل وإنشاء رمز وصول (Access Token) مطلوب للوصول إلى واجهات برمجة التطبيقات المتاحة. ويجب تضمين رمز الوصول في طلبات واجهة برمجة التطبيقات اللاحقة لأغراض المصادقة.مدة صلاحية الرمز: يكون رمز الوصول الذي تم إنشاؤه صالحًا لمدة ساعة من وقت إصداره. وبمجرد انتهاء صلاحيته، يجب إنشاء رمز وصول جديد.رمز التحديث (Refresh Token): لا يتوفر رمز تحديث (Refresh Token)، لذلك يجب إنشاء رمز وصول جديد يدويًا في كل مرة تنتهي فيها صلاحية الرمز الحالي.التزامن (Concurrency): يؤدي طلب إنشاء رمز وصول جديد إلى إبطال رمز الوصول السابق.

تُستخدم واجهة برمجة التطبيقات (API) هذه لمصادقة العميل وإنشاء رمز وصول (Access Token) مطلوب للوصول إلى واجهات برمجة التطبيقات المتاحة. ويجب تضمين رمز الوصول في طلبات واجهة برمجة التطبيقات اللاحقة لأغراض المصادقة.

 يكون رمز الوصول الذي تم إنشاؤه صالحًا لمدة 

 من وقت إصداره. وبمجرد انتهاء صلاحيته، يجب إنشاء رمز وصول جديد.

 لا يتوفر رمز تحديث (Refresh Token)، لذلك يجب إنشاء رمز وصول جديد يدويًا في كل مرة تنتهي فيها صلاحية الرمز الحالي.

 يؤدي طلب إنشاء رمز وصول جديد إلى إبطال رمز الوصول السابق.

userName

email

password

Authorization

تتيح واجهات برمجة التطبيقات (APIs) هذه للمستخدمين المصرّح لهم ما يلي:<ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">إنشاء شحنة واحدة أو عدة شحنات على منصة سبل.</div></li><li class="slate-li " ><div style="position:relative">تتبع الشحنات باستخدام رقم بوليصة الشحن (AWB Number) أو الرقم المرجعي (Reference Number).</div></li></ul>

تتيح واجهات برمجة التطبيقات (APIs) هذه للمستخدمين المصرّح لهم ما يلي:

لإعداد ويب هوك، يرجى ملاحظة ما يلي:<ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"> المصادقة : سيتم إرسال أحداث الـويب هوك باستخدام إحدى طريقتي Basic Authorization أو X-API-Key، مع استخدام بيانات اعتماد من اختياركم.</div></li><li class="slate-li " ><div style="position:relative"> بيانات الطلب : تم توضيح هيكل بيانات الطلب أدناه. يرجى التأكد من أن نقطة النهاية الخاصة بكم قادرة على استقبال هذا الهيكل.</div></li><li class="slate-li " ><div style="position:relative"> الأحداث : تم إدراج قائمة بأكثر الأحداث شيوعًا التي يتم إرسالها ضمن تبويب للرجوع إليها واستخدامها في عملية الربط.</div></li><li class="slate-li " ><div style="position:relative"> نقطة نهاية الـويب هوك: يتعين عليكم تزويدنا بعنوان نقطة نهاية الويب هوك الخاص بكم حتى نتمكن من تهيئته وربطه بحسابكم.</div></li></ol>ملاحظة: يجب أن تُرجع واجهة برمجة التطبيقات (API) استجابة منظمة حتى نتمكن من التحقق مما إذا كانت عملية التحديث قد تمت بنجاح. ويكون نموذج الاستجابة المتوقع كما يلي:public class DynamicTrackingShipmentResponse{    public bool IsSuccess { get; set; }    public string? Exception { get; set; }}بدون هذه الاستجابة، لن يتمكن نظامنا من التحقق مما إذا كان طلب الـويب هوك قد تم قبوله بنجاح أو فشل. يرجى التأكد من تنفيذ الاستجابة وفقًا للنموذج المطلوب.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>بيانات طلب الويب هوك<ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">يرجى التأكد من أن نقطة النهاية الخاصة بكم قادرة على استقبال هذا الهيكل.</div></li><li class="slate-li " ><div style="position:relative">يرجى ملاحظة أن بيانات طلب الويب هوك لدينا تستخدم تنسيق وهي ؛Camel Case , غير حساسة لحالة الأحرف لذلك يرجى التأكد من أن الويب هوك الخاص بكم لا يعتمد على حالة الأحرف وأنه قادر على استقبال البيانات بأي من التنسيقين (Camel Case أو Pascal Case) مع الحفاظ على مرونة النظام في حال إضافة أي حقول جديدة من جانبنا مستقبلآ.</div></li></ol><div class="code-block-wrapper" style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">{
 &quot;airwaybill&quot;: &quot;***************&quot;,
 &quot;eventCode&quot;: &quot;GN012&quot;,
 &quot;event&quot;: &quot;Shipment Delivered&quot;,
 &quot;eventName&quot;: &quot;Shipment Delivered&quot;,
 &quot;supplier&quot;: null,
 &quot;userName&quot;: &quot;admin&quot;,
 &quot;notes&quot;: null,
 &quot;actionDate&quot;: &quot;2024-10-29T17:30:00+00:00&quot;,
 &quot;eventCountry&quot;: &quot;AMMAN&quot;,
 &quot;eventCity&quot;: &quot;AMMAN&quot;,
 &quot;eventSubCode&quot;: null,
 &quot;eventSubName&quot;: null
 }</textarea><code class="language-plainText keep-markup drop-tokens">{
 &quot;airwaybill&quot;: &quot;***************&quot;,
 &quot;eventCode&quot;: &quot;GN012&quot;,
 &quot;event&quot;: &quot;Shipment Delivered&quot;,
 &quot;eventName&quot;: &quot;Shipment Delivered&quot;,
 &quot;supplier&quot;: null,
 &quot;userName&quot;: &quot;admin&quot;,
 &quot;notes&quot;: null,
 &quot;actionDate&quot;: &quot;2024-10-29T17:30:00+00:00&quot;,
 &quot;eventCountry&quot;: &quot;AMMAN&quot;,
 &quot;eventCity&quot;: &quot;AMMAN&quot;,
 &quot;eventSubCode&quot;: null,
 &quot;eventSubName&quot;: null
 }</code></pre></div>

 يجب أن تُرجع واجهة برمجة التطبيقات (API) استجابة منظمة حتى نتمكن من التحقق مما إذا كانت عملية التحديث قد تمت بنجاح. ويكون نموذج الاستجابة المتوقع كما يلي:

public class DynamicTrackingShipmentResponse

    public bool IsSuccess { get; set; }

    public string? Exception { get; set; }

بدون هذه الاستجابة، لن يتمكن نظامنا من التحقق مما إذا كان طلب ال

 قد تم قبوله بنجاح أو فشل. يرجى التأكد من تنفيذ الاستجابة وفقًا للنموذج المطلوب.

Sections