تعریف سرویس تخمین زمان رسیدن
API تخمین زمان رسیدن ETA مپ با دریافت مختصات دو یا چند نقطه یا یک polyline، دادههای مربوط به مسیر بهینه بین نقاط را بهصورت خروجی JSON ارائه میدهد. با مشخصکردن دو یا چند نقطه میتوانید مسیر بهینه و زمان رسیدن به مقصد را دریافت کنید.
نکته 🚧
در حال حاضر ETA در شهرهای تهران، مشهد، تبریز، کرج، اصفهان، شیراز، رشت و قم با درنظرگرفتن ترافیک و در سایر شهرها بدون درنظرگرفتن ترافیک محاسبه میشود. در نتیجه زمان رسیدن به مقصد در این هشت شهر بهصورت واقعی و برای سایر نقاط براساس حداکثر سرعت تردد در معابر محاسبه میشود.
دسترسی به این سرویس از طریق API مپ که با Convention Restful طراحی شده فراهم است. سرویس ETA امکانات مختلفی را برای توسعهدهندگان فراهم میکند، از جمله:
- مسیریابی جهت تردد با خودرو
- درنظرگرفتن محدودیتهای ترافیکی مانند طرح ترافیک یا زوج و فرد
اصطلاحات کاربردی
| ردیف | نام اصطلاح | شرح اصطلاح |
|---|---|---|
| ۱ | Geohash | فرمتی برای نگهداری دادههای جغرافیایی بهصورت فشرده |
| ۲ | Leaflet | یک کتابخانه متنباز JavaScript که بهعنوان ابزاری رایج برای ساخت و نمایش نقشه بهصورت تحت وب استفاده میشود. |
| ۳ | Front end | راهکاری برای نمایش اطلاعات از طریق یک رابط گرافیکی جهت مشاهده و تعامل کاربر با استفاده از HTML، CSS یا JavaScript |
| ۴ | Zoom Level | اندازه بزرگنمایی نقشه |
| ۵ | Lat (Latitude) | عرض جغرافیایی |
| ۶ | Lon (Longitude) | طول جغرافیایی |
ساختار استفاده
API تخمین زمان رسیدن مپ بهصورت Restful توسعه داده شده است و انعطافپذیری بالایی برای روشهای مختلف پیادهسازی دارد. پارامترهای زیر باید بهعنوان ورودی در اختیار سرویس قرار گیرند.
| پارامتر ورودی | نوع | توضیحات | مقادیر قابل دریافت | جنس | نحوه ارسال |
|---|---|---|---|---|---|
x-api-key * | اجباری | کلید اختصاصی دسترسی به سرویسهای مپ | API Key اختصاصی معتبر | string | Header |
coordinates * | اجباری | مختصات نقاط مبدأ و مقصد بهصورت ترتیبی یا یک polyline | آرایهای از مختصات بهصورت lon,lat یا یک polyline | string | Path |
نکته 🚧
اگر API Key اختصاصی خود را دریافت نکردهاید، با ثبتنام رایگان و ساخت یک پروژه جدید میتوانید API Key دریافت کنید.
ساختار مختصات ورودی
ساختار ورود مختصات دو نقطه:
origin_longitude,origin_latitude;destination_longitude,destination_latitudeساختار ورود مختصات چند نقطه:
origin_longitude,origin_latitude;destination1_longitude,destination1_latitude;destination2_longitude,destination2_latitude;…;destinationx_longitude,destinationx_latitudeساختار ورود مختصات مجموعهای از نقاط بهصورت polyline:
polyline(ofp_Ik_vpAilAyu@te@g`E)عملکرد سرویس
سرویس ETA با دریافت مقادیر ورودی، خلاصه مسیر بهینه بین مبدأ و مقصد یا مجموعه نقاط مشخصشده را ارائه میدهد. این دادهها شامل مسیر، زمان رسیدن به مقصد و طول مسیر است. زمان رسیدن در شهرهای دارای پوشش ترافیکی براساس دادههای ترافیکی و در سایر نقاط با درنظرگرفتن حداکثر سرعت معابر محاسبه میشود.
| سرویس | Endpoint |
|---|---|
| تخمین زمان رسیدن (ETA) | /eta/route/v1/driving/{coordinates} |
نکته 🚧
مسیریابی با اعمال محدودیت طرح ترافیک برای شهرهای اصفهان، تبریز، تهران، کرج و مشهد در دسترس است.
نکته 🚧
مسیریابی با اعمال محدودیت طرح زوج و فرد برای شهر تهران در دسترس است.
پارامترهای خروجی
خروجی API تخمین زمان رسیدن مپ بهصورت JSON شامل موارد زیر است:
| پارامتر خروجی | توضیحات | جنس |
|---|---|---|
code | کد پاسخ که نشانگر ساختار اطلاعات ارسالشده یا پاسخ دریافتی است. | string |
routes | جزئیات مسیر بهینه | object |
routes.distance | مسافت کل | numeric |
routes.duration | زمان کل | numeric |
Postman
فایل Postman این API را با کلیک روی گزینه زیر دریافت کنید.