از کلیدهای API با Directions API استفاده کنید

محصولات پلتفرم نقشه‌های گوگل با محدود کردن فراخوانی‌های API به مواردی که اعتبارنامه‌های احراز هویت مناسبی ارائه می‌دهند، از استفاده غیرمجاز ایمن می‌شوند. این اعتبارنامه‌ها به شکل یک کلید API هستند - یک رشته الفبایی عددی منحصر به فرد که حساب پرداخت گوگل شما را با پروژه شما و با API یا SDK خاص مرتبط می‌کند.

این راهنما نحوه ایجاد، محدود کردن و استفاده از کلید API خود را برای پلتفرم نقشه‌های گوگل نشان می‌دهد.

قبل از اینکه شروع کنی

قبل از شروع استفاده از Directions API، به یک پروژه با یک حساب صورتحساب و فعال بودن Directions API نیاز دارید. برای کسب اطلاعات بیشتر، به بخش «تنظیم در کنسول ابری» مراجعه کنید.

ایجاد کلیدهای API

کلید API یک شناسه منحصر به فرد است که درخواست‌های مرتبط با پروژه شما را برای اهداف استفاده و صدور صورتحساب تأیید می‌کند. شما باید حداقل یک کلید API مرتبط با پروژه خود داشته باشید.

برای ایجاد کلید API:

کنسول

  1. به صفحه Google Maps Platform > Credentials بروید.

    به صفحه اعتبارنامه‌ها بروید

  2. در صفحه اعتبارنامه‌ها ، روی ایجاد اعتبارنامه > کلید API کلیک کنید.
    کادر محاوره‌ای ایجاد کلید API، کلید API تازه ایجاد شده شما را نمایش می‌دهد.
  3. روی بستن کلیک کنید.
    کلید API جدید در صفحه اعتبارنامه‌ها ، زیر عنوان کلیدهای API، فهرست شده است.
    (به یاد داشته باشید که قبل از استفاده از کلید API در محیط عملیاتی، آن را محدود کنید .)

SDK ابری

gcloud services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

درباره Google Cloud SDK ، نصب Cloud SDK و دستورات زیر بیشتر بخوانید:

محدود کردن کلیدهای API

گوگل اکیداً توصیه می‌کند که کلیدهای API خود را با محدود کردن استفاده از آنها به APIهایی که فقط برای برنامه شما مورد نیاز هستند، محدود کنید. محدود کردن کلیدهای API با محافظت از برنامه شما در برابر درخواست‌های غیرمجاز، امنیت آن را افزایش می‌دهد. شما از نظر مالی مسئول هزینه‌های ناشی از سوءاستفاده از کلیدهای API بدون محدودیت هستید. برای اطلاعات بیشتر، به بهترین شیوه‌های امنیت API مراجعه کنید.

برای محدود کردن یک کلید API:

کنسول

  1. به صفحه Google Maps Platform > Credentials بروید.

    به صفحه اعتبارنامه‌ها بروید

  2. کلید API مورد نظر برای اعمال محدودیت را انتخاب کنید. صفحه مربوط به ویژگی کلید API نمایش داده می‌شود.
  3. در قسمت محدودیت‌های کلیدی ، محدودیت‌های زیر را تنظیم کنید:
    • محدودیت‌های برنامه:
      1. برای پذیرش درخواست‌ها از لیست آدرس‌های IP سرور وب که ارائه می‌دهید، آدرس‌های IP (سرورهای وب، cron jobs و غیره) را از لیست محدودیت‌های برنامه انتخاب کنید. یک یا چند آدرس IPv4 یا IPv6 یا زیرشبکه را با استفاده از نماد CIDR مشخص کنید. آدرس‌های IP باید با آدرس منبعی که سرورهای پلتفرم نقشه‌های گوگل مشاهده می‌کنند مطابقت داشته باشند. اگر از ترجمه آدرس شبکه (NAT) استفاده می‌کنید، این معمولاً با آدرس IP عمومی دستگاه شما مطابقت دارد.
    • محدودیت‌های API:
      1. روی کلید محدود کردن کلیک کنید.
      2. از منوی کشویی Select APIs، گزینه‌ی Directions API را انتخاب کنید. اگر Directions API در لیست نیست، باید آن را فعال کنید .
  4. برای نهایی کردن تغییرات، روی ذخیره کلیک کنید.

SDK ابری

کلیدهای موجود را فهرست کنید.

gcloud services api-keys list --project="PROJECT"

محدودیت‌های موجود روی کلید موجود را پاک کنید.

gcloud services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

محدودیت‌های جدیدی را روی کلید موجود اعمال کنید.

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=directions-backend.googleapis.com
    --allowed-ips="IP_ADDRESS"

درباره Google Cloud SDK ، نصب Cloud SDK و دستورات زیر بیشتر بخوانید:

اضافه کردن کلید API به درخواست شما

شما باید یک کلید API را به هر درخواست API مربوط به Directions اضافه کنید. در مثال زیر، YOUR_API_KEY با کلید API خود جایگزین کنید.

https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key= YOUR_API_KEY

برای درخواست‌هایی که از کلید API استفاده می‌کنند، HTTPS الزامی است.