درخواست سفر (Ride Request)

درخواست سفر از طریق این API قابل انجام است.

---

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

• آدرس: api/v3/ride/request
• متد: POST
• نوع محتوا: application/json
• احراز هویت: نیازمند token

---

احراز هویت

• این درخواست نیاز به یک token دارد که باید در هدر Authorization ارسال شود.
• همچنین، بدنه درخواست باید شامل اطلاعات مورد نیاز برای پردازش درخواست باشد.

---

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

درخواست باید شامل یک شیء JSON با ساختار زیر باشد:

فیلد	نوع داده	ضروری	توضیحات
by_credit	boolean	بله	آیا هزینه سفر به‌صورت اعتباری پرداخت می‌شود؟
contact_id	integer	خیر	شناسه تماس (در صورت وجود)
contact_mobile	string	بله	شماره تلفن تماس
contact_name	string	بله	نام تماس
current_ride_hri	string	خیر	شناسه سفر فعلی (در صورت وجود)
destination_lat	float	بله	عرض جغرافیایی مقصد
destination_lng	float	بله	طول جغرافیایی مقصد
destination_place_id	integer	خیر	شناسه مکان مقصد
extra_destination_lat	float	خیر	عرض جغرافیایی مقصد اضافی (در صورت وجود)
extra_destination_lng	float	خیر	طول جغرافیایی مقصد اضافی (در صورت وجود)
extra_info	string	خیر	اطلاعات اضافی
hurry_flag	integer	خیر	پرچم وضعیت عجله (0 یا 1)
hurry_price	integer	خیر	قیمت اضافی برای درخواست فوری
is_paid_by_recipient	boolean	بله	آیا هزینه توسط گیرنده پرداخت می‌شود؟
origin_lat	float	بله	عرض جغرافیایی مبدا
origin_lng	float	بله	طول جغرافیایی مبدا
package_info	string	خیر	اطلاعات بسته (در صورت وجود)
recipient_cellphone	string	بله	شماره تلفن گیرنده
recipient_name	string	بله	نام گیرنده
round_trip	boolean	بله	آیا سفر رفت و برگشت است؟
sender_cellphone	string	بله	شماره تلفن فرستنده
service_type	string	بله	نوع سرویس
voucher_code	string	خیر	کد تخفیف در صورت وجود
waiting	string	خیر	مدت زمان انتظار (در صورت وجود)

---

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

curl --location 'https://corporate.snapp.site/api/v3/ride/request' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: <your_authorization_token>' \
--data-raw '{
    "by_credit": true,
    "contact_id": 0,
    "contact_mobile": "string",
    "contact_name": "string",
    "current_ride_hri": "string",
    "destination_lat": 35.706868,
    "destination_lng": 51.337287,
    "destination_place_id": 0,
    "extra_destination_lat": 0,
    "extra_destination_lng": 0,
    "extra_info": "string",
    "hurry_flag": 1,
    "hurry_price": 0,
    "is_for_friend": false,
    "is_paid_by_recipient": true,
    "origin_lat": 35.734083,
    "origin_lng": 51.482242,
    "package_info": "string",
    "recipient_cellphone": "string",
    "recipient_name": "string",
    "round_trip": true,
    "sender_cellphone": "string",
    "service_type": "standard",
    "voucher_code": "string",
    "waiting": "string"
}'

---

پاسخ موفق

در صورت موفقیت، پاسخ به شکل زیر خواهد بود:

{
    "data": {
        "request_id": "string"
    },
    "status": "integer",
    "message": "string"
}

فیلد	نوع داده	توضیحات
request_id	string	شناسه درخواست ایجاد شده
status	integer	وضعیت درخواست
message	string	پیام مربوط به درخواست

---

خطاها

کد وضعیت	توضیحات
400	درخواست نامعتبر است
404	منبع مورد نظر یافت نشد
500	خطای داخلی سرور

---

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

• در صورت دریافت اطلاعات نامعتبر، پیام خطای مناسب دریافت خواهید کرد.
• پس از ارسال درخواست، می‌توانید از شناسه درخواست برای پیگیری وضعیت آن استفاده کنید.

---