۱- اولین قدم ثبت‌نام و دریافت Api Key از نوع سرویس است. کافیست در صفحه زیر فرم مربوطه را تکمیل کنید تا توکن کلید دسترسی ساخته شود و پس از یک دقیقه فعال شود.
فهرست مطالب این صفحه
۲- استفاده از آدرس زیر برای تولید تصویری از نقشه با ابعاد و موقعیت مودنظرتان:
https://api.neshan.org/v4/static?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12¢er=32.657307%2C51.677579&markerToken=101139.nRmybq5
پارامترهای ورودی
- key: کلید اختصاصی که از پنل توسعه‌دهندگان نشان دریافت کرده‌اید.
- type: استایل نقشه که یکی از مقادیر neshan ، dreamy-gold ، dreamy ، standard-day ، standard-night و osm-bright می‌تواند باشد.
- zoom: سطح بزرگنمایی نقشه که حداقل ۵ و حداکثر ۱۹ می‌تواند باشد.
- center: مرکز نقشه که بصورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.
- width: عرض تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
- height: ارتفاع تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
- markerToken: آیکن مرکز عکس را با استفاده از این پارامتر می‌توانید تنظیم کنید. برای ایجاد آیکن دلخواه می‌توانید با مراجعه به پنل کاربری خود، قسمت آیکن ها تصویر مارکر دلخواه را آپلود نمائید، اگر این پارامتر دورن درخواست ارسالی وجود نداشته باشد روی عکس مارکری قرار نمی‌گیرد.
خروجی تولید شده با ارسال درخواست:
ابزار تولید نقشه استاتیک:
برای سهولت کار، ابزار Neshan Static Map Maker طراحی و پیاده‌سازی شده است. شما می‌توانید توسط این ابزار به راحتی فقط با چند کلیک ساده آدرس نقشه‌ی استاتیک موردنظرتان را تولید و سپس در وب‌سایت یا اپلیکیشن خود استفاده نمایید.
با فراخوانی این API در صورت وجود اشکال ممکن است، خطاهای زیر در خروجی برای شما ارسال گردند. شناسایی و مدیریت این خطاها می‌تواند به از بروز خطاهای احتمالی در اپلیکیشن شما جلوگیری کند. این خطاها عبارتند از:
470 : CoordinateParseError
چنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.
480 : KeyNotFound
در صورتی که در فراخوانی وب‌سرویس از یک Api Key نامتعبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.
481 : LimitExceeded
در صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.
482 : RateExceeded
چنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.
483 : ApiKeyTypeError
کلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس موردنظر استفاده کنید.
484 : ApiWhiteListError
با توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.
485 : ApiServiceListError
سرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.
500 : GenericError
در صورت بروز خطایی غیر از خطاهای بالا این خطا گزارش می‌شود.
