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

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

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

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

اطلاع
  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/v4/static/arc

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

پارامترتوضیحاتنوع
keyکلید اختصاصی که از پنل توسعه‌دهندگان نشان دریافت کرده‌اید.اجباری
typeاستایل نقشه که یکی از مقادیر neshan، standard-day، standard-night، dreamy-gold، dreamy و osm-bright می‌تواند باشد.اجباری
fromنقطه مبدا خط کمان که به‌صورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.اجباری
toنقطه مقصد خط کمان که به‌صورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.اجباری
widthعرض تصویر موردنظر که حداکثر 2000 پیکسل می‌تواند باشد.اجباری
heightارتفاع تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.اجباری
dashedاین پارامتر استایل خط کمان را مشخص می‌کند. مقادیر آن true یا false می‌تواند باشد. در صورتی که این پارامتر true باشد، خط کمان به‌صورت خط‌چین نمایش داده می‌شود.اختیاری
colorرنگ خط کمان را مشخص می‌کند، مقدار آن به‌صورت هگز وارد می‌شود.اختیاری
marker1Tokenآیکن مارکر مبدا کمان را مشخص می‌کند. مقدار آن توکن فایل آپلود شده در قسمت آیکن‌های پروفایل می‌باشد.اختیاری
marker2Tokenآیکن مارکر مقصد کمان را مشخص می‌کند. مقدار آن توکن فایل آپلود شده در قسمت آیکن‌های پروفایل می‌باشد.اختیاری

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

curl --location 'https://api.neshan.org/v4/static/arc?key=<YOUR_API_KEY>&type=standard-night&from=46.298018%2C38.073362&to=60.649445%2C25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=<MARKER_TOKEN>&marker2Token=<MARKER_TOKEN>'

خروجی تولید شده با ارسال درخواست:

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

تـوجه! جهت آپلود فایل برای تصویر مارکر های مبدا و مقصد دلخواه به صفحه زیر در پروفایل خود مراجعه بفرمایید. پس از آپلود هر تصویر توکنی در اختیار شما قرار میگیرد که زمان فراخوانی سرویس نقشه استاتیک در پارامترهای marker1Token و marker2Token به عنوان مارکر مبدا و مقصد ارسال می شود. https://platform.neshan.org/panel/icons

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

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