چگونه از کلید دسترسی مپ استفاده کنیم؟
پیادهسازی API Key مپ در پروژه شما
پیادهسازی API Key مپ در پروژه شما
سرویسهای نقشه مپ به نحوی طراحی و ارائه شده که برای تمامی توسعه دهندگان قابل دسترسی باشه. این دسترسی شامل ارائه سرویس باکیفیت برابر برای تمامی کاربران در تمامی پلنهای استفاده از سرویس نقشه مپ هستش به نحوی که قادر باشن از تمامی امکانات و سرویسهای مپ با بالاترین کیفیت و سرعت استفاده کنند. از این رو کاربران در تمامی پلنهای زیرساخت نقشه مپ دسترسی یکسانی به کیفیت سرویسهای نقشه دارند و تنها یک پیش شرط برای این دسترسی در نظر گرفته شده است: ساخت حساب کاربری و استفاده از توکن دریافتی در پروژه.
برای این کار کافیه تا حساب کاربری خودتون رو در ناحیه کاربری ایجاد کنید و اولین پروژه خودتون رو بسازید. به محض ایجاد یک پروژه جدید یک کلید دسترسی (API Key) در اختیار شما قرار داده میشود که باید اون رو بر اساس راهنمای توسعه دهندگان داخل پروژه قرار بدین تا دسترسی شما به سرویسهای نقشه مپ تضمین بشه. بر اساس همین کلید دسترسی میزان مصرف شما محاسبه میشه که در حساب کاربری قابل مشاهده است.
حالا این سوال مطرح میشه که در چه صورتی دسترسی به سرویسهای مپ محدود میشه یا به زبان دیگه کی با پاسخ unauthorized مواجه میشیم؟
برای این سوال سه جواب وجود داره:
برای اینکه با این موارد مواجه نشید بهتره با جزئیات مربوط به محدودیت دسترسی به هر یک از سرویسهای نقشه مپ آشنا باشید.
برای استفاده از سرویس نقشه پایه (Tile) روشهای مختلفی وجود داره. شما میتونید با استفاده از API نقشه پایه یا SDKهای مختلف نقشه رو نمایش بدید.
اگر از API نقشه پایه استفاده میکنید باید توکن دریافتی رو داخل Header درخواست ارسال کنید. در غیر این صورت با پیام 401 یا همان خطای Unauthorized مواجه خواهید شد. این خطا منجر به عدم نمایش کامل نقشه و دریافت Tileها به صورت زیر میشود.
پارامترهای ورودی | نوع پارامتر | توضیحات | مقادیر قابل دریافت | جنس پارامتر | نحوه ارسال |
x-api-key * | اجباری | کلیدی اختصاصی دسترسی به سرویسهای مپ (API Key) | API Key اختصاصی معتبر | string | Header |
سرویسهای پایه نقشه شامل آدرسیابی (reverse geocode)، مسیریابی (route)، جستجو (search)، ماتریس فاصله (distance matrix)، تخمین زمان رسیدن (ETA) و کروکی نقشه (static map) میباشد. برای دسترسی به این سرویسها هم باید کلید دسترسی معتبر (API Key) داشته باشید.
برای تضمین دسترسی به این سرویس حتما بر اساس مستندات سرویس، توکن دریافتی را در Header درخواست ارسال نمایید.
پارامترهای ورودی | نوع پارامتر | توضیحات | مقادیر قابل دریافت | جنس پارامتر | نحوه ارسال |
x-api-key * | اجباری | کلیدی اختصاصی دسترسی به سرویسهای مپ (API Key) | API Key اختصاصی معتبر | string | Header |
برای استفاده از Web SDK مپ نیاز به API Key یا همان کلید دسترسی معتبر دارید. برای دریافت کلید دسترسی لازم هست تا ابتدا حساب کاربری خودتون رو ایجاد کنید و با ساخت پروژه، کلید دسترسی دریافت کنید.
PROPERTY | TYPE | DEFAULT | DESCRIPTION |
---|---|---|---|
apiKey | string | undefined | Your API-Key |
برای استفاده از Android SDK مپ نیاز به API Key یا همان کلید دسترسی معتبر دارید. برای دریافت کلید دسترسی لازم هست تا ابتدا حساب کاربری خودتون رو ایجاد کنید و با ساخت پروژه، کلید دسترسی دریافت کنید.
برای اطلاعات بیشتر برای نحوه استفاده از کلید دسترسی مپ در Android SDK به مستندات نصب Android SDK مراجعه کنید.
برای استفاده از iOS SDK مپ نیاز به API Key یا همان کلید دسترسی معتبر دارید. برای دریافت کلید دسترسی لازم هست تا ابتدا حساب کاربری خودتون رو ایجاد کنید و با ساخت پروژه، کلید دسترسی دریافت کنید.
بعد از دریافت API Key، از بخش Navigation bar وارد فایل info.plist شوید و یک Key-Value جدید بسازید، نوع آن را String انتخاب کنید، سپس Key را MAPIRAccessToken و Value را API Key که از حساب کاربری دریافت کردید را قرار دهید.
برای اطلاعات بیشتر برای نحوه استفاده از کلید دسترسی مپ در iOS SDK به مستندات نصب iOS SDK مراجعه کنید.
برای استفاده از React Native SDK مپ نیاز به API Key یا همان کلید دسترسی معتبر دارید. برای دریافت کلید دسترسی لازم هست تا ابتدا حساب کاربری خودتون رو ایجاد کنید و با ساخت پروژه، کلید دسترسی دریافت کنید.
پیادهسازی کلید دسترسی در iOS و Android تفاوتهایی دارد.
اگر از React Native برای توسعه اپلیکیشن iOS استفاده میکنید، به راهنمای ورود API Key در iOS مراجعه کنید.
برای استفاده از سرویس React Native مپ در پروژه Android هم باید prob مربوط به apiKey (در نسخههای قدیمی React Native SDK از Prob برابر با accessToken) را با کلید دسترسی دریافتی ایجاد کنید. برای جزییات بیشتر میتوانید به مستندات راهنمای React Native SDK مراجعه کنید.
برای استفاده از کامپوننت ReactJS مپ نیاز به API Key یا همان کلید دسترسی معتبر دارید. برای دریافت کلید دسترسی لازم هست تا ابتدا حساب کاربری خودتون رو ایجاد کنید و با ساخت پروژه، کلید دسترسی دریافت کنید.
پس از دریافت کلید دسترسی اقدام به ایجاد نقشه کرده و توکن دریافتی را قرار داده و سپس کامپوننت Mapir را در بخش return از تابع render فراخوانی میکنیم تا نقشه اولیه ایجاد گردد.
برای اطلاعات بیشتر برای نحوه استفاده از کلید دسترسی مپ در کامپوننت ReactJS به مستندات نصب کامپوننت ReactJS مراجعه کنید.