پرش به مطلب اصلی

بروزرسانی وضعیت سفرها (Refresh)

برای به‌روزرسانی وضعیت یک سفر بر اساس شناسه (ID) آن استفاده می‌شود.


اطلاعات عمومی

  • آدرس: /api/v2/ride/{ride_id}/refresh
  • متد: GET
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

احراز هویت

  • این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.

پارامترهای درخواست

درخواست باید شامل پارامتر زیر در URL باشد:

فیلدنوع دادهضروریتوضیحات
ride_idstringبلهشناسه سفر برای دریافت اطلاعات

نمونه درخواست

curl --location 'https://corporate.snapp.site/api/v2/ride/SNP-250223-02506-0982/refresh' \
--header 'Authorization: <your_authorization_token>'

پاسخ موفق

{
"ride_info": {
"ride_id": "SNP-250223-02506-0982",
"current_state": 1,
"name": "تست",
"cellphone": "+989121292382",
"service_type": 1,
"is_delivery": false,
"sub_service_type": null,
"final_price": 170000,
"can_use_ride_voucher": true,
"start_time": "14:51",
"shareurl": "https://share-look-snapp-ode-008.apps.private.okd4.teh-1.snappcloud.io/passenger/MnqOd9R2ANMvly0V4Wjv",
"payment_type": 0,
"origin": {
"lat": 35.77764371308767,
"lng": 51.45786528970834,
"formatted_address": "تهران، دروس، محمد صالح حسینی، حمید چیذری تقاطع پروانه",
"details": ""
},
"destination": {
"lat": 35.693760422521066,
"lng": 51.46110716693616,
"formatted_address": "تهران، زاهد گیلانی، پیروزی، باقری، انصاری قبل از بهار",
"details": ""
},
"friend_info": {
"is_for_friend": false,
"name": "تست",
"cellphone": "+989111002233"
}
},
"service_type": {
"name": "اسنپ",
"type": "1",
"tooltip": "",
"photo_url": "https://web-cdn.snapp.ir/pricing/service-types/Yalda2024/Eco.png",
"description": "به صرفه",
"long_description": "",
"is_new": false,
"can_use_voucher": true,
"is_ride_options_enabled": true,
"need_additional_information": false,
"can_change_regular_offer_state": false,
"is_surged": false,
"surge": null
},
"options": null,
"waitings": [
{
"key": "0m-5m",
"price": 30000,
"text": "۰ تا ۵ دقیقه"
}
],
"tips": []
}
فیلدنوع دادهتوضیحات
ride_infoobjectاطلاعات مربوط به سفر فعال
service_typeobjectاطلاعات نوع خدمات (مانند نوع تاکسی یا سرویس)
optionsobjectاطلاعات اضافی سفر (در این مثال null است)
waitingsarrayآرایه‌ای از گزینه‌های زمان انتظار با قیمت‌ها
tipsarrayلیست انعام‌ها
friend_infoobjectاطلاعات دوست که سفر برای او انجام می‌شود

خطاها

کد وضعیتتوضیحات
400درخواست نامعتبر
401نیاز به احراز هویت
500خطای داخلی سرور

توضیحات تکمیلی

  • داده‌های مربوط به waitings شامل قیمت‌های مربوط به زمان انتظار هستند که در حالت‌های مختلف ارائه می‌شوند.
  • ride_info شامل اطلاعات مهمی همچون شناسه سفر، زمان شروع، آدرس مبدأ و مقصد، قیمت نهایی و غیره می‌باشد.
  • service_type نوع و ویژگی‌های سرویس (مثل نوع خودرو) را نشان می‌دهد.