وب‌سرویس‌های نشان

وب‌سرویس مسیریابی
نگارش 1.0.0

با استفاده از وب‌سرویس مسیریابی شما می‌توانید بهترین مسیر بین دو نقطه‌ی مشخص را به دست آورید. محاسبه مسیر با توجه به ترافیک معابر محاسبه می‌شود و هر پاسخ ممکن است شامل یک یا چند مسیر باشد. در هر مسیر زمان سفر و مسافت آن محاسبه می‌گردد. مرتب‌سازی مسیرها بر اساس بهترین مسیر از نظر زمان و مسافت خواهد بود.

شیوه‌ی فراخوانی:
GET:
	https://api.neshan.org/v1/routing?origin=LATITUDE,LONGITUDE&destination=LATITUDE,LONGITUDE&alternative=true
Headers:
	Api-Key: YOUR_API_KEY
پارامترهای ورودی:
  • origin: مختصات نقطه شروع مسیریابی، این مختصات باید به صورت latitude,longitude باشد که دو عدد با کاما از هم جدا شده‌اند.
  • destination: مختصات نقطه پایان مسیریابی که قالب آن مانند نقطه شروع است.
  • alternative: این پارامتر اختیاری بوده و مقادیر آن true یا false می‌تواند باشد. در صورتی که این پارامتر true باشد و مسیرهای جایگزین برای نقاط مشخص شده وجود داشته باشد این مسیرها در پاسخ ارائه خواهند شد. (مقدار پیش فرض این پارامتر false است)
فرمت پاسخ:
{
  "routes": [
    {
      "legs": [
        {
          "summary": "آزادی - ولیعصر",
          "distance": {
            "value": 8998,
            "text": "۹ کیلومتر"
          },
          "duration": {
            "value": 2012,
            "text": "۳۴ دقیقه"
          },
          "steps": [
            {
              "start_location": [
                51.344035,
                35.695452
              ],
              "distance": {
                "value": 46,
                "text": "۴۶ متر"
              },
              "duration": {
                "value": 11,
                "text": ""
              },
              "name": "عضدی جنوبی",
              "instruction": "در جهت شرق در عضدی جنوبی قرار بگیرید"
            }
          ]
        }
      ],
      "overview_polyline": {
        "points": "qwzxEgckxHBeAWEDq ..."
      }
    }
  ]
}
اجزای این پاسخ بصورت زیر می‌باشند:
  • routes: هر پاسخ مسیر ممکن است از یک یا چند route تشکیل شده باشد. مسیرهای جایگزین یا alternative بسته به موقعیت ممکن است تغییر کنند. اجزای یک route بصورت زیر می‌باشند:
    • legs: در صورتی که مسیریابی فقط بین دو نقطه انجام شود route دارای یک leg خواهد بود. اگر بیش از دو نقطه جهت مسیریابی ارسال شود بین هر دو نقطه در route یک leg ایجاد می‌شود. هر leg از اجزای زیر تشکیل شده‌است:
      • summery: خلاصه‌ای از مسیر که معمولا شامل نام دو خیابان اصلی ابتدا و انتهای آن leg است. با استفاده از خلاصه به صورت حدودی مسیر مشخص می‌شود.
      • distance: فاصله بین دو نقطه که به دو صورت عددی و قابل خواندن ارائه می‌شود. در فرمت عددی مقدار فاصله به متر است.
      • duration: زمان سفر بین دو نقطه که به دو صورت عددی و قابل خواند ارائه می‌شود. در فرمت عددی مقدار زمان به ثانیه است.
      • steps: با توجه به شکل مسیر و پیچ خم‌های موجود یک leg می‌تواند شامل یک یا چند step باشد. اجزای یک step بصورت زیر می‌باشند:
        • startLocation: نقطه شروع step. با توجه به اینکه یک مسیر به چند step تقسیم می‌شود نقطه شروع هر step در این قسمت به صورت یک آرایه که حاوی دو عدد logtitude و latitude هست آورده خواهد شد.
        • distance: طول step که به دو صورت عددی و قابل خواندن ارائه می‌شود. در فرمت عددی مقدار فاصله به متر است.
        • duration: زمان سفر در این step که به دو صورت عددی و قابل خواند ارائه می‌شود. در فرمت عددی مقدار زمان به ثانیه است.
        • name: نام معبری که step در آن شروع می‌شود.
        • instruction: یک دستور العمل که مشخص می‌کنند چطور باید وارد این step شد.
    • overviewPolyline: ژئومتری مسیر که به صورت Encoded polyline ارائه می‌شود. جهت اطلاعات بیشتر در مورد این فرمت به اینجا مراجعه کنید.