چطور شروع کنم؟

استفاده از Neshan Maps API

۱- اولین قدم ثبت‌نام و دریافت Api Key برای اپلیکیشنی است که قصد دارید در آن از Map Api نشان در استفاده کنید. کافیست در در صفحه زیر فرم مربوطه را تکمیل کنید تا بلافاصله Api Key به ایمیل شما ارسال گردد.

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

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

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

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

470 : CoordinateParseError

چنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.

480 : KeyNotFound

در صورتی که در فراخوانی وب‌سرویس از یک Api Key نامتعبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.

481 : LimitExceeded

در صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.

482 : RateExceeded

چنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.

483 : ApiKeyTypeError

کلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس موردنظر استفاده کنید.

484 : ApiWhiteListError

با توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.

485 : ApiServiceListError

سرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.

500 : GenericError

در صورت بروز خطایی غیر از خطاهای بالا این خطا گزارش می‌شود.

دسترسی سریع به مستندات وب‌سرویس‌های پلتفرم نشان (Neshan Maps APIs)

برای مشاهده نحوه استفاده از هر یک از سرویس‌های (API) نقشه و مسیریابی در پلتفرم نشان، و قرار دادن کلید دسترسی یا API Key تولید شده در پنل کاربری‌تان، روی نام API مورد نظر کلیک کنید.

سرویس مسیریابی (Routing API) برای خودرو و موتورسیکلت

مشاهده

سرویس جستجوی نام معابر، مکان‌ها و نام‌های قدیمی (Search API)

مشاهده

سرویس مسیریابی فروشنده دوره گرد Traveling Salesman Problem)TSP API)

مشاهده

سرویس تبدیل موقعیت به آدرس (Reverse Geocoding API)

مشاهده

سرویس تبدیل آدرس به موقعیت (Geocoding API)

مشاهده

سرویس ماتریس فاصله (Distance Matrix API)

مشاهده

سرویس نگاشت نقطه بر نقشه (Map Matching API)

مشاهده