توثيق API للمطورين
اربط متجرك أو تطبيقك الخاص مباشرة بمنصة جاسور — إنشاء شحنات ومتابعتها عبر واجهة REST بسيطة.
المصادقة
احصل على مفتاح API من لوحة التاجر: لوحة التاجر ← التكاملات ← توليد مفتاح API. المفتاح يظهر مرة واحدة فقط وقت التوليد — احفظه فورًا. أرسله في كل طلب داخل ترويسة Authorization.
Authorization: Bearer YOUR_API_TOKEN Accept: application/json Content-Type: application/json
إنشاء شحنة
بينشئ شحنة جديدة مرتبطة بحسابك، ويرجّع رقم التتبع فورًا.
| الحقل | النوع | الوصف |
|---|---|---|
| receiver_nameمطلوب | string | اسم المستلم، بحد أقصى 100 حرف. |
| receiver_phoneمطلوب | string | رقم هاتف المستلم. |
| receiver_emirate_idمطلوب | integer | معرّف الإمارة — جدول الإمارات. |
| receiver_addressمطلوب | string | العنوان التفصيلي. |
| payment_typeمطلوب | string | طريقة الدفع، القيم المتاحة: cod أو prepaid. |
| receiver_areaاختياري | string | الحي أو المنطقة، بحد أقصى 100 حرف. |
| weightاختياري | number | الوزن بالكيلوجرام. لو اتسابت، بيستخدم النظام الوزن الافتراضي. |
| piecesاختياري | integer | عدد القطع، الافتراضي 1. |
| cod_amountاختياري | number | مبلغ الدفع عند الاستلام — مطلوب عند اختيار الدفع عند الاستلام. |
| notesاختياري | string | ملاحظات حرة على الشحنة. |
| external_order_idاختياري | string | رقم الطلب من نظامك الخاص — يمنع تكرار الشحنة، شوف منع التكرار. |
{
"receiver_name": "أحمد محمد",
"receiver_phone": "0501234567",
"receiver_emirate_id": 1,
"receiver_address": "شارع الشيخ زايد",
"payment_type": "cod",
"cod_amount": 150,
"external_order_id": "ORDER-1042"
}
{
"data": {
"tracking_number": "UAE-2026-000481",
"status": "pending",
"status_label": "تم إنشاء الطلب",
"cod_amount": 150,
"delivery_fee": 20
}
}
curl -X POST https://gasoordel.com/api/v1/shipments \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"receiver_name":"أحمد محمد","receiver_phone":"0501234567","receiver_emirate_id":1,"receiver_address":"شارع الشيخ زايد","payment_type":"cod","cod_amount":150}'
قائمة الشحنات
بترجّع شحنات حسابك، 20 شحنة في الصفحة، الأحدث أولًا.
curl https://gasoordel.com/api/v1/shipments \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"
تفاصيل شحنة
جلب شحنة واحدة برقم التتبع الخاص بيها.
curl https://gasoordel.com/api/v1/shipments/UAE-2026-000481 \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"
منع التكرار
لو بعتّ external_order_id وبعتّ نفس الطلب تاني بالغلط (انقطاع شبكة، إعادة محاولة تلقائية من نظامك)، السيرفر مش هينشئ شحنة جديدة — هيرجّعلك نفس الشحنة اللي اتعملت أول مرة بنفس رقم التتبع.
الأخطاء
أكواد الحالة اللي ممكن تستقبلها والمعنى بتاع كل واحد.
| الكود | المعنى |
|---|---|
| 201 | الشحنة اتعملت بنجاح. |
| 200 | الطلب نجح (قوائم وتفاصيل). |
| 401 | مفتاح API غير صحيح أو منتهي أو ملغي. |
| 403 | حساب التاجر غير مفعّل، أو الاتصال (المفتاح) موقوف. |
| 404 | الشحنة غير موجودة أو مش تبع حسابك. |
| 422 | بيانات ناقصة أو غير صحيحة — راجع رسالة الخطأ الموضّحة لكل حقل. |
| 500 | خطأ من السيرفر — جرب تاني بعد شوية، ولو استمر تواصل معانا. |
رموز الإمارات
استخدم الرقم في حقل receiver_emirate_id.
| id | الإمارة |
|---|---|
| 1 | دبي |
| 2 | أبوظبي |
| 3 | الشارقة |
| 4 | عجمان |
| 5 | رأس الخيمة |
| 6 | الفجيرة |
| 7 | أم القيوين |
حالات الشحنة
القيمة اللي بترجع في حقل status، بالترتيب اللي بتتحرك بيه الشحنة عادةً.
| status | الوصف |
|---|---|
| pending | تم إنشاء الطلب |
| pickup_pending | بانتظار الاستلام |
| picked_up | تم استلام الشحنة |
| in_warehouse | في المستودع |
| out_for_delivery | جاري التوصيل |
| delivered | تم التسليم |
| failed_delivery | فشل التسليم |
| postponed | مؤجل - إعادة توصيل |
| returned | مرتجع |
ملاحظة: وصف الحالة (status_label) بيرجع بالعربي دايمًا من الـ API بغض النظر عن لغة الموقع.