در حال بارگذاری

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

نقشه استاتیک با امکان رسم کمان بین مبدا و مقصد

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

اطلاع
  1. ۱

    اولین قدم ثبت‌نام و دریافت API KEY برای اپلیکیشنی است که قصد دارید در آن از Map Api نشان استفاده کنید. کافیست در لینک فوق فرم مربوطه را تکمیل کنید تا بلافاصله API KEY را دریافت نمایید.

  2. ۲

    Api Key دریافتی از پنل توسعه‌دهندگان نشان را به صورتی که در ادامه مشاهده می‌کنید از طریق کلید Api-Key در header درخواست سرویس بگنجانید.

  3. ۳

    درخواست خود را با توجه به پارامترهایی که مربوط به سرویس موردنظرتان است با متد GET فراخوانی کنید.

  4. ۴

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

شیوه‌ فراخوانی

آدرس Endpoint

با استفاده از آدرس زیر تولید تصویری از نقشه با ابعاد و موقعیت موردنظرتان امکان‌پذیر می‌باشد:

https://api.neshan.org/v5/static/arc

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

پارامترتوضیحاتنوع
keyکلید اختصاصی که از پنل توسعه‌دهندگان نشان دریافت کرده‌اید.اجباری
fromLatitudeعرض جغرافیایی نقطه مبدا خط کمان که باید در سیستم مختصات جغرافیایی WGS84 تعریف شده باشد.اجباری
fromLongitudeطول جغرافیایی نقطه مبدا خط کمان که باید در سیستم مختصات جغرافیایی WGS84 تعریف شده باشد.اجباری
toLatitudeعرض جغرافیایی نقطه مقصد خط کمان که باید در سیستم مختصات جغرافیایی WGS84 تعریف شده باشد.اجباری
toLongitudeطول جغرافیایی نقطه مقصد خط کمان که باید در سیستم مختصات جغرافیایی WGS84 تعریف شده باشد.اجباری
widthعرض تصویر موردنظر که حداقل 200 و حداکثر 2048 پیکسل می‌تواند باشد. در صورت عدم ارسال، مقدار پیش‌فرض 512 در نظر گرفته می‌شود.اختیاری
heightارتفاع تصویر موردنظر که حداقل 200 و حداکثر 2048 پیکسل می‌تواند باشد. در صورت عدم ارسال، مقدار پیش‌فرض 512 در نظر گرفته می‌شود.اختیاری
styleاستایل نقشه که یکی از مقادیر light و dark می‌تواند باشد. در صورت عدم ارسال، مقدار پیش‌فرض light در نظر گرفته می‌شود.اختیاری
colorرنگ خط کمان را مشخص می‌کند، مقدار آن به‌صورت هگز وارد می‌شود (مثال: #f50559 یا f50559). در صورت عدم ارسال، رنگ مشکی در نظر گرفته می‌شود.اختیاری
dashedاین پارامتر استایل خط کمان را مشخص می‌کند. مقادیر آن true یا false می‌تواند باشد. در صورتی که این پارامتر true باشد، خط کمان به‌صورت خط‌چین نمایش داده می‌شود. مقدار پیش‌فرض false می‌باشد.اختیاری
fromMarkerمارکر نقطه مبدا کمان را مشخص می‌کند. مقدار آن می‌تواند یکی از رنگ‌های از پیش تعریف‌شده (red, green, blue, violet) یا توکن فایل آپلود شده در قسمت آیکن‌های پروفایل باشد.اختیاری
toMarkerمارکر نقطه مقصد کمان را مشخص می‌کند. مقدار آن می‌تواند یکی از رنگ‌های از پیش تعریف‌شده (red, green, blue, violet) یا توکن فایل آپلود شده در قسمت آیکن‌های پروفایل باشد.اختیاری

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

curl --location 'https://api.neshan.org/v5/static/arc?key=<YOUR_API_KEY>&style=light&fromLatitude=38.073362&fromLongitude=46.298018&toLatitude=25.292741&toLongitude=60.649445&width=600&height=600&dashed=true&color=%23FF0AA5&fromMarker=<MARKER_TOKEN>&toMarker=<MARKER_TOKEN>'
خروجی تولید شده با ارسال درخواست:

رسم کمان بین دو نقطه در نقشه نشان

نکته

برای مارکر مبدا و مقصد می‌توانید از رنگ‌های از پیش تعریف‌شده (red, green, blue, violet) استفاده کنید. در صورت نیاز به آپلود تصویر مارکر دلخواه، به این آدرس در پروفایل خود مراجعه بفرمایید. پس از آپلود هر تصویر توکنی در اختیار شما قرار می‌گیرد که زمان فراخوانی سرویس نقشه استاتیک در پارامترهای fromMarker و toMarker به عنوان مارکر مبدا و مقصد ارسال می‌شود.

کد خطاهای سرویس

HTTP CodeStatusDescription
400INVALID_ARGUMENTخطا در پارامتر های ورودی
470CoordinateParseErrorچنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.
480KeyNotFoundدر صورتی که در فراخوانی وب‌سرویس از یک Api Key نامعتبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.
481LimitExceededدر صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.
482RateExceededچنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.
483ApiKeyTypeErrorکلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس مورد نظر استفاده کنید.
484ApiWhiteListErrorبا توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.
485ApiServiceListErrorسرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.
500GenericErrorوقوع خطای ناشناخته
503render_timeoutزمان مجاز برای رندر به پایان رسید
503overloadedعدم پاسخگویی سرور