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

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

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

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

کنسول

  1. به صفحه پلتفرم نقشه های گوگل > اعتبارنامه بروید.

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

  2. در صفحه اعتبارنامه‌ها ، روی ایجاد اعتبارنامه > کلید API کلیک کنید.
    گفتگوی ایجاد شده کلید API کلید API تازه ایجاد شده شما را نمایش می دهد.
  3. روی 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 خود را محدود می‌کنید، باید اثر انگشت گواهینامه SHA-1 کلید امضایی را که برای امضای برنامه استفاده شده است ارائه دهید. دو نوع گواهی وجود دارد:

  • گواهی اشکال زدایی : فقط از این نوع گواهی با برنامه هایی که در حال آزمایش هستید و سایر کدهای غیر تولیدی استفاده کنید. سعی نکنید برنامه‌ای را منتشر کنید که با گواهی اشکال‌زدایی امضا شده است. ابزارهای Android SDK این گواهی را به طور خودکار هنگام اجرای یک ساخت اشکال‌زدایی تولید می‌کنند.
  • گواهی انتشار : زمانی که آماده انتشار برنامه خود در فروشگاه برنامه هستید از این گواهی استفاده کنید. ابزارهای Android SDK این گواهی را زمانی که یک نسخه انتشار را اجرا می کنید تولید می کنند.

برای اطلاعات بیشتر در مورد امضای برنامه Android و گواهینامه ها، به راهنمای برنامه خود را امضا کنید .

برای دستورالعمل‌هایی درباره نحوه یافتن اثر انگشت گواهی امضای خود، به مراجع زیر مراجعه کنید:

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

کنسول

  1. به صفحه پلتفرم نقشه های گوگل > اعتبارنامه بروید.

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

  2. کلید API را که می خواهید محدودیتی روی آن تنظیم کنید، انتخاب کنید. صفحه ویژگی کلید API ظاهر می شود.
  3. در زیر کلید محدودیت‌ها ، محدودیت‌های زیر را تنظیم کنید:
    • محدودیت های کاربردی:
      1. برنامه های اندروید را انتخاب کنید.
      2. روی + افزودن نام بسته و اثر انگشت کلیک کنید.
      3. نام بسته و اثر انگشت گواهی SHA-1 خود را وارد کنید. به عنوان مثال: 
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • محدودیت های API:
      1. روی Restrict key کلیک کنید.
      2. از منوی کشویی Select APIs Navigation SDK را انتخاب کنید. اگر Navigation SDK در لیست نیست، باید آن را فعال کنید .
  4. برای نهایی کردن تغییرات خود، روی ذخیره کلیک کنید.

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/keys/KEY_ID" \
    --api-target="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

بعدش چی

اکنون که یک کلید API دارید، می توانید یک پروژه Android Studio را ایجاد و پیکربندی کنید. همانطور که در راه اندازی یک پروژه Android Studio توضیح داده شده است.

پروژه Android Studio خود را راه اندازی کنید