نوشتن یک نظر متد ارائه‌دهنده نقشه، تصویر یک نقطه مشخص جغرافیایی را با درجه زوم موردنظرتان به شما ارائه می‌کند. برای استفاده از این متد، سه پارامتر طول مکان تایل، عرض مکان تایل (در ماتریس mapViewer) و مقدار زوم به عنوان ورودی گرفته شده و یک تصویر با مختصات و میزان بزرگ‌نمایی مشخص به عنوان خروجی برای شما ارسال می‌شود.
از این سرویس جهت نمایش نقشه های پارسی جو در سرویس های مختلف نمایش دهنده نقشه استفاده می شود. جهت راهنمایی بیشتر می توانید به صفحه نحوه انتشار نقشه در لیف لت، نحوه انتشار نقشه در اوپن لایر و نحوه انتشار نقشه با نمایش دهنده گوگل مراجعه نمایید.
توجه: در تمام وب‌سرویس‌های سفارشی پارسی‌جو، اطلاعات ورودی از طریق پارامترها، به شیوه GET یا POST دریافت و خروجی در قالب فرمت JSON برگشت داده می‌شود.
توجه: جهت اعتبارسنجی لازم است رشته api-key دریافت شده را در Header درخواست خود با پارامتر api-key قرار دهید.
در صورتی که از نمایش دهنده های آماده جهت نمایش نقشه استفاده می کنید و امکان دسترسی به Header درخواست را ندارید، می توانید رشته اعتبارسنجی را به صورت پارامتر apikey در درخواست ارسال کنید. (راهنمای دریافت API Key)
ساختار ورودی
http(s)://developers.parsijoo.ir/web-service/v1/map/?type=tile
نمونه
https://developers.parsijoo.ir/web-service/v1/map/?type=tile&x=X_Matrix&y=Y_Matrix&z=ZoomLevel&apikey=YourAPIKey
پارامترهای ورودی
عنوان | مشخصات | نوع متغیر | لزوم استفاده | نام متغیر در پارامتر ورودی | توضیحات |
X_Matrix | طول مکان تایل | String | اجباری | x | در ماتریس mapViewer |
Y_Matrix | عرض مکان تایل | String | اجباری | y | در ماتریس mapViewer |
ZoomLevel | زوم | String | اجباری | z | مقادیر زوم از 3 تا 19 است. |
YourAPIKey
| رشته اعتبارسنجی | String | اختیاری | apikey | در صورتی که api-key را در هدر درخواست خود ارسال کرده اید، ارسال apikey در پارامتر ورودی اجباری نیست، در غیر اینصورت ارسال apikey در پارامتر ورودی الزامی است. |
توجه: جهت ارسال API Key در هدر می بایست از پارامتر api-key استفاده شود و در صورت ارسال API Key به صورت پارامتر در درخواست، می بایست از پارامتر apikey استفاده نمود.
توجه: مقادیر طول و عرض مکان تایل در ماتریس map viewer توسط نمایش دهنده های نقشه (اوپن لایر، لیف لت و ...) به صورت خودکار تولید میگردد.
پارامترهای خروجی
مشخصات | نوع | نام متغیر در پارامتر خروجی | توضیحات |
تصویر متناظر با نقطه | PNG | image | image/png |
خطاهای مربوط به پاسخ درخواست:
400 پارامترها ناقص هستند.
404 متدی با این نام پیدا نشده است.
405 متد فراخوانی Get یا Post اشتباه است.
500 خطا در انجام عملیات، بعدا تلاش کنید.
مثال
https://developers.parsijoo.ir/web-service/v1/map/?type=tile&x=42666&y=26641&z=16
