سرویس تبدیل آدرس به موقعیت
شیوه‌ی فراخوانی:
GET:
https://api.neshan.org/v4/geocoding?address=ADDRESS
Headers:
Api-Key: YOUR_API_KEYپارامتر های وروردی:
- address: عبارت جستجو
فرمت پاسخ:
{
"location": {
"x": 59.58030012321334,
"y": 36.30608816378243
},
"status": "OK"
}اجزای این پاسخ بصورت زیر می‌باشند:
- status: وضعیت کلی پاسخ را نشان میدهد.
- location: مختصات معادل با آدرس وارد شده را نشان میدهد که شامل اجزای زیر است
- x: طول جغرافیایی
- y: عرض جغرافیایی
-
تا جایی که ممکن است ترتیب قرار گرفتن اجزا آدرس به صورت زیر باشد
استان + شهر / روستا + میدان + خیابان + کوچه + پلاک
نکته: شماره پلاک در شهرهای تهران، مشهد، تبریز، کرج قابل استفاده است. -
حتما همه اجزا آدرس با جدا کننده space از هم جدا شده باشند.
متال : شهیدبابایی بهتر است با جدا کننده به صورت شهید بابایی ارسال شود. -
مشخصات مربوط به poi ها مانند نام ساختمان طبقات و برجها تا جایی که ممکن است از آدرس حذف شود.
مثال: آذربایجان شرقی تبریز خیابان ارتش شمالی کوچه بازارچه رنگی ساختمان رضوی
به آدرس زیر تغییر یابد
آذربایجان شرقی تبریز خیابان ارتش شمالی کوچه بازارچه رنگی - اگر مقصد آدرس روستا است بعد از استان بلافاصله نام روستا آورده شود و دیگر نیازی به نام شهر نیست
با فراخوانی این API در صورت وجود اشکال ممکن است، خطاهای زیر در خروجی برای شما ارسال گردند. شناسایی و مدیریت این خطاها می‌تواند به از بروز خطاهای احتمالی در اپلیکیشن شما جلوگیری کند. این خطاها عبارتند از:
470 : CoordinateParseError
چنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.
480 : KeyNotFound
در صورتی که در فراخوانی وب‌سرویس از یک Api Key نامتعبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.
481 : LimitExceeded
در صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.
482 : RateExceeded
چنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.
483 : ApiKeyTypeError
کلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس موردنظر استفاده کنید.
484 : ApiWhiteListError
با توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.
485 : ApiServiceListError
سرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.
500 : GenericError
در صورت بروز خطایی غیر از خطاهای بالا این خطا گزارش می‌شود.
