۱- اولین قدم ثبت‌نام و دریافت Api Key از نوع سرویس است. کافیست در صفحه زیر فرم مربوطه را تکمیل کنید تا توکن کلید دسترسی ساخته شود و پس از یک دقیقه فعال شود.
۲- استفاده از آدرس زیر برای تولید تصویری از نقشه با ابعاد و موقعیت مودنظرتان:
https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018,38.073362&to=60.649445,25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56پارامترهای ورودی
- key: کلید اختصاصی که از پنل توسعه‌دهندگان نشان دریافت کرده‌اید.
- type: استایل نقشه که یکی از مقادیر neshan ، standard-day ، standard-night ، dreamly-gold ، dreamy و osm-bright می‌تواند باشد.
- from:نقطه مبدا خط کمان که بصورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.
- to: نقطه مقصد خط کمان که بصورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.
- width: عرض تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
- height: ارتفاع تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
- dashed: این پارامتر استایل خط کمان را مشخص می‌کند و اختیاری بوده و مقادیر آن true یا false می‌تواند باشد. در صورتی که این پارامتر true باشد، خط کمان به صورت خط‌چین نمایش داده می‌شود.
- color: رنگ خط کمان را مشخص می‌کند، مقدار آن به صورت هگز وارد می شود.
- marker1Token: آیکن ماکر مبدا کمان را مشخص می‌کند.مقدار آن توکن فایل آپلود شده در قسمت آیکن های پروفایل می باشد.
- marker2Token: آیکن ماکر مقصد کمان را مشخص می‌کند.مقدار آن توکن فایل آپلود شده در قسمت آیکن های پروفایل می باشد.
خروجی تولید شده با ارسال درخواست:
خروجی تولید شده با ارسال درخواست:
با مراجعه به صفحه ابزار رسم کمان می‌توانید به سادگی و با چند کلیک بر روی نقشه تصویر کمان بین دو نقطه را ایجاد نمائید و سپس در وب‌سایت یا اپلیکیشن خود استفاده نمایید.
با فراخوانی این API در صورت وجود اشکال ممکن است، خطاهای زیر در خروجی برای شما ارسال گردند. شناسایی و مدیریت این خطاها می‌تواند به از بروز خطاهای احتمالی در اپلیکیشن شما جلوگیری کند. این خطاها عبارتند از:
470 : CoordinateParseError
چنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.
480 : KeyNotFound
در صورتی که در فراخوانی وب‌سرویس از یک Api Key نامتعبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.
481 : LimitExceeded
در صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.
482 : RateExceeded
چنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.
483 : ApiKeyTypeError
کلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس موردنظر استفاده کنید.
484 : ApiWhiteListError
با توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.
485 : ApiServiceListError
سرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.
500 : GenericError
در صورت بروز خطایی غیر از خطاهای بالا این خطا گزارش می‌شود.
