محصولات پلتفرم نقشه‌های Google با محدود کردن تماس‌های API به کسانی که اعتبارنامه‌های احراز هویت مناسب را ارائه می‌کنند، از استفاده غیرمجاز محافظت می‌شوند. این اعتبارنامه ها به شکل یک کلید API هستند - یک رشته الفبایی عددی منحصر به فرد که حساب صورتحساب Google شما را با پروژه شما و با API یا SDK خاص مرتبط می کند.
این راهنما نحوه ایجاد، محدود کردن و استفاده از کلید API خود را برای پلتفرم Google Maps نشان می‌دهد.
قبل از شروع
قبل از شروع استفاده از Roads API، به پروژه ای نیاز دارید که یک حساب صورتحساب و Roads API فعال باشد. برای کسب اطلاعات بیشتر، به راه اندازی در کنسول Cloud مراجعه کنید.
ایجاد کلیدهای API
کلید API یک شناسه منحصر به فرد است که درخواست های مرتبط با پروژه شما را برای اهداف استفاده و صورتحساب احراز هویت می کند. شما باید حداقل یک کلید API مرتبط با پروژه خود داشته باشید.
برای ایجاد یک کلید API:
کنسول
به صفحه پلتفرم نقشه های گوگل > اعتبارنامه بروید.
- در صفحه اعتبارنامه‌ها ، روی ایجاد اعتبارنامه > کلید API کلیک کنید.
گفتگوی ایجاد شده کلید API کلید API تازه ایجاد شده شما را نمایش می دهد. - روی Close کلیک کنید.
کلید API جدید در صفحه Credentials در زیر کلیدهای API فهرست شده است.
(به یاد داشته باشید که کلید API را قبل از استفاده از آن در تولید محدود کنید .)
Cloud SDK
gcloud alpha services api-keys create \ --project "PROJECT" \ --display-name "DISPLAY_NAME"
درباره Google Cloud SDK ، نصب Cloud SDK و دستورات زیر بیشتر بخوانید:
محدود کردن کلیدهای API
Google اکیداً توصیه می‌کند که کلیدهای API خود را با محدود کردن استفاده از آن‌ها به آن دسته از APIهای مورد نیاز برای برنامه‌تان محدود کنید. محدود کردن کلیدهای API با محافظت از برنامه شما در برابر درخواست‌های غیرمجاز، امنیت را به آن اضافه می‌کند. برای اطلاعات بیشتر، بهترین شیوه های امنیتی API را ببینید.
برای محدود کردن یک کلید API:
کنسول
به صفحه پلتفرم نقشه های گوگل > اعتبارنامه بروید.
- کلید API را که می خواهید محدودیتی روی آن تنظیم کنید، انتخاب کنید. صفحه ویژگی کلید API ظاهر می شود.
- در زیر محدودیت های کلیدی ، محدودیت های زیر را تنظیم کنید:
- محدودیت های کاربردی:
- برای پذیرفتن درخواست‌ها از فهرست آدرس‌های IP سرور وب که ارائه می‌کنید، آدرس‌های IP (سرورهای وب، کارهای cron و غیره) را از لیست محدودیت‌های برنامه انتخاب کنید. یک یا چند آدرس IPv4 یا IPv6 یا زیرشبکه را با استفاده از نماد CIDR مشخص کنید. آدرس‌های IP باید با آدرس منبعی که سرورهای پلتفرم Google Maps مشاهده می‌کنند مطابقت داشته باشد. اگر از ترجمه آدرس شبکه (NAT) استفاده می کنید، این معمولاً با آدرس IP عمومی دستگاه شما مطابقت دارد.
- محدودیت های API:
- روی Restrict key کلیک کنید.
- از منوی کشویی Select APIs Roads API را انتخاب کنید. اگر Roads API در لیست نیست، باید آن را فعال کنید .
- برای نهایی کردن تغییرات خود، روی ذخیره کلیک کنید.
Cloud SDK
فهرست کلیدهای موجود
gcloud services api-keys list --project="PROJECT"
محدودیت های موجود در کلید موجود را پاک کنید.
gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \ --clear-restrictions
محدودیت های جدیدی را روی کلید موجود تنظیم کنید.
gcloud alpha services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \ --api-target=service=roads.googleapis.com --allowed-ips="IP_ADDRESS"
درباره Google Cloud SDK ، نصب Cloud SDK و دستورات زیر بیشتر بخوانید:
افزودن کلید API به درخواست شما
با هر درخواست Roads API باید یک کلید API اضافه کنید. در مثال زیر، YOUR_API_KEY با کلید API خود جایگزین کنید.
https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key= YOUR_API_KEYبرای درخواست هایی که از کلید API استفاده می کنند، HTTPS لازم است.