سرویس Reverse Geocoding
از طریق وب‌سرویس تبدیل نقطه‌ی جغرافیایی به آدرس (Reverse Geocoding API ) به سادگی میتوانید با ارسال طول و عرض جغرافیایی موردنظر، اطلاعاتی نظیر آدرس دقیق، نام محله، منطقه‌ی شهرداری، در طرح ترافیک بودن (تهران) و در طرح زوج و فرد بودن (تهران، مشهد، اصفهان) آن نقطه را دریافت کنید.
پیشنهاد می‌شود جهت آشنایی بیشتر با وب‌سرویس تبدیل پوینت به آدرس پستی مطلب تبدیل موقعیت به آدرس در پلتفرم نقشه نشان را در بلاگ نشان مطالعه کنید.
فهرست مطالب این صفحه
شیوه‌ی فراخوانی:
GET:
https://api.neshan.org/v5/reverse?lat=LATITUDE&lng=LONGITUDE
Headers:
Api-Key: YOUR_API_KEYپارامتر های وروردی:
- lat: عرض جغرافیایی (latitude)
- lng: طول جغرافیایی (longitude)
فرمت پاسخ:
{
"status": "OK",
"formatted_address": "تهران، دکتر فاطمی، حجاب، سازمان آب، بین دائمی و عبداله زاده",
"route_name": "سازمان آب",
"route_type": "secondary",
"neighbourhood": "فاطمي",
"city": "تهران",
"state": "استان تهران",
"place": null,
"municipality_zone": "6",
"in_traffic_zone": "true",
"in_odd_even_zone": "true",
"village": null,
"county": شهرستان تهران,
"district": "بخش مرکزی شهرستان تهران",
}اجزای این پاسخ بصورت زیر می‌باشند:
- status: در صورت موفقیت‌آمیز بودن اجرای درخواست مقدار OK در آن قرار می‌گیرد.
- formatted_address: آدرس کامل موقعیت مورد نظر شامل استان، شهر، محله و خیابان
- route_name: نام خیابان انتهایی آدرس
- route_type: نوع خیابان انتهایی آدرس
- neighbourhood: نام محله (در صورت وجود)
- city: نام شهر
- state: نام استان
- place: نام مکان عمومی که موقعیت انتخابی در آن قرار گرفته است (در صورت وجود)
- municipality_zone: منطقه شهرداری (در صورت وجود)
- in_traffic_zone: آیا نقطه‌ی موردنظر در طرح ترافیک قرار دارد؟
- in_odd_even_zone: ایا نقطه‌ی موردنظر در طرح زوج و فرد قرار دارد؟
- village: نام روستا (در صورت وجود)
- county: نام شهرستان
- district: نام بخش
مزایای این روش فراخوانی به شرح زیر است.
- دیگر نیازی به ارسال کلید دسترسی به صورت کلاینت ساید ندارید و کلید دسترسی شما در معرض سرقت قرار نمیگیرد.
- میتوانید برای کلید خود whitelist تعیین کنید.
- در صورت انتشار ورژن جدید سرویس ها در پلتفرم نشان براحتی امکان بروزرسانی api را خواهید داشت.
با فراخوانی این API در صورت وجود اشکال ممکن است، خطاهای زیر در خروجی برای شما ارسال گردند. شناسایی و مدیریت این خطاها می‌تواند به از بروز خطاهای احتمالی در اپلیکیشن شما جلوگیری کند. این خطاها عبارتند از:
470 : CoordinateParseError
چنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.
480 : KeyNotFound
در صورتی که در فراخوانی وب‌سرویس از یک Api Key نامتعبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.
481 : LimitExceeded
در صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.
482 : RateExceeded
چنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.
483 : ApiKeyTypeError
کلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس موردنظر استفاده کنید.
484 : ApiWhiteListError
با توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.
485 : ApiServiceListError
سرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.
500 : GenericError
در صورت بروز خطایی غیر از خطاهای بالا این خطا گزارش می‌شود.
