کلیدهای ثبت نام و API، کلیدهای ثبت نام و API

برای استفاده از Google Awareness API، باید یک کلید Google API به برنامه خود اضافه کنید. نوع کلید API مورد نیاز شما یک کلید API Android است.

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

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

چندین مرحله برای دریافت کلید برنامه مورد نیاز است. آنها در این راهنما به تفصیل توضیح داده شده اند و به شرح زیر خلاصه می شوند:

  1. اطلاعات مربوط به گواهی برنامه خود را دریافت کنید.
  2. یک پروژه را در کنسول Google Developers ثبت کنید و User Context API را به عنوان سرویسی برای پروژه اضافه کنید.
  3. درخواست یک کلید
  4. کلید را به برنامه خود اضافه کنید. برای انجام این کار، یک عنصر به مانیفست برنامه خود اضافه کنید.

اطلاعات گواهی برنامه خود را پیدا کنید

کلید API مبتنی بر فرم کوتاهی از گواهی دیجیتال برنامه شما است که به عنوان اثر انگشت SHA-1 آن شناخته می‌شود. برای نمایش اثر انگشت SHA-1 برای گواهی، ابتدا مطمئن شوید که از گواهی مناسب استفاده می کنید. ممکن است دو گواهی زیر را برای انتخاب داشته باشید:

  • گواهی اشکال‌زدایی : ابزارهای Android SDK این گواهی را به‌طور خودکار هنگام ساخت اشکال‌زدایی تولید می‌کنند. این گواهی را فقط با برنامه هایی که در حال آزمایش هستید استفاده کنید. سعی نکنید برنامه‌ای را منتشر کنید که با گواهی اشکال‌زدایی امضا شده است. گواهی اشکال زدایی با جزئیات بیشتری در بخش Sign your debug build در مستندات توسعه دهنده Android توضیح داده شده است.
  • گواهی انتشار : ابزارهای Android SDK این گواهی را هنگامی که یک نسخه نسخه را انجام می دهید، تولید می کنند. همچنین می توانید این گواهی را با برنامه keytool ایجاد کنید. زمانی که آماده انتشار برنامه خود در جهان هستید از این گواهی استفاده کنید.

برای اطلاعات بیشتر در مورد keytool ، به اسناد Oracle آن مراجعه کنید.

گواهی اشکال زدایی

نمایش اثر انگشت گواهی اشکال زدایی

از برنامه keytool با پارامتر -v برای نمایش اثر انگشت SHA-1 گواهی استفاده کنید. برای این کار مراحل زیر را انجام دهید:

  1. فایل فروشگاه کلید اشکال زدایی خود را پیدا کنید. نام فایل debug.keystore است و اولین باری که پروژه خود را می سازید ایجاد می شود. به طور پیش‌فرض، در همان فهرستی که فایل‌های دستگاه مجازی Android (AVD) شما ذخیره می‌شود:

    • OS X و Linux : ~/.android/
    • ویندوز ویستا و ویندوز 7 : C:\Users\your_user_name\.android\

  2. اثر انگشت SHA-1 را فهرست کنید:

    • برای لینوکس یا OS X، یک پنجره ترمینال را باز کنید و موارد زیر را وارد کنید:

      keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

    • برای ویندوز ویستا و ویندوز 7، موارد زیر را اجرا کنید:

      keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android

شما باید خروجی مشابه زیر را ببینید:

Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
     MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
     SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
     Signature algorithm name: SHA1withRSA
     Version: 3
گواهی انتشار

نمایش اثر انگشت گواهی انتشار

از برنامه keytool با پارامتر -v برای نمایش اثر انگشت SHA-1 گواهی استفاده کنید. برای این کار مراحل زیر را انجام دهید:

  1. فایل فروشگاه کلید گواهی انتشار خود را پیدا کنید. هیچ مکان یا نام پیش‌فرضی برای ذخیره کلید انتشار وجود ندارد. اگر زمانی که برنامه خود را برای انتشار می‌سازید، یکی را مشخص نکنید، ساخت .apk شما را بدون امضا می‌گذارد و قبل از انتشار آن باید آن را امضا کنید. برای گواهی انتشار، به نام مستعار گواهی، گذرواژه‌های فروشگاه کلید و گواهی نیز نیاز دارید.

  2. برای فهرست کردن نام‌های مستعار برای همه کلیدهای یک فروشگاه کلید، موارد زیر را وارد کنید:

    keytool -list -keystore your_keystore_name
  3. your_keystore_name با مسیر کاملا واجد شرایط و نام keystore جایگزین کنید. شامل پسوند .keystore . وقتی از شما خواسته شد رمز عبور فروشگاه کلید را وارد کنید. سپس، keytool همه نام‌های مستعار را در keystore نمایش می‌دهد.

  4. موارد زیر را در ترمینال یا خط فرمان وارد کنید:

          keytool -list -v -keystore your_keystore_name -alias your_alias_name
  5. your_keystore_name با مسیر کاملا واجد شرایط و نام keystore جایگزین کنید. پسوند .keystore را اضافه کنید.
  6. your_alias_name با نام مستعاری که هنگام ایجاد گواهی به آن اختصاص داده اید، جایگزین کنید.

شما باید خروجی مشابه زیر را ببینید:

Alias name: <alias_name>
Creation date: Feb 02, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4cc9b300
Valid from: Mon Feb 02 08:01:04 UTC 2013 until: Mon Feb 02 18:05:04 PST 2033
Certificate fingerprints:
    MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6B:AC:F9
    SHA1: BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:90:AF:A1:66:6E:44:5D:75
    Signature algorithm name: SHA1withRSA
    Version: 3

خطی که با SHA1 شروع می شود حاوی اثر انگشت SHA-1 گواهی است. اثر انگشت دنباله ای از 20 عدد هگزادسیمال دو رقمی است که با دو نقطه از هم جدا شده اند.

یک کلید API از Google Developers Console دریافت کنید

برای شروع کار با Google Awareness API، روی دکمه دریافت کلید کلیک کنید. به کنسول توسعه‌دهندگان Google پیوند می‌خورد، که شما را در این فرآیند راهنمایی می‌کند و Awareness API را به‌طور خودکار فعال می‌کند.

یک کلید بگیر

همچنین، این مراحل را برای دریافت یک کلید API دنبال کنید:

  1. به Google Developers Console بروید.
  2. یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
  3. برای فعال کردن Awareness API روی Continue کلیک کنید.

  4. در صفحه "Credentials"، یک کلید Android ایجاد کنید و اعتبار API را تنظیم کنید.

  5. در گفتگوی "ایجاد کلید"، باید استفاده خود را به برنامه های Android محدود کنید. برای انجام این کار، اثر انگشت SHA-1 و نام بسته برنامه خود را مانند مثال زیر وارد کنید:

    BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75

com.example.android.awareness-example

  6. روی ایجاد کلیک کنید. کلید Android API جدید شما در لیست کلیدهای API پروژه شما ظاهر می شود. یک کلید API رشته ای از کاراکترها است، مانند موارد زیر:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0

اکنون که یک کلید API دارید، می‌توانید همانطور که در راهنمای شروع کار توضیح داده شده است، آن را به مانیفست برنامه خود اضافه کنید.

API های اضافی را فعال کنید

Awareness API به شما امکان می‌دهد به انواع مختلفی از داده‌های متنی، مانند beaconها دسترسی داشته باشید. برای استفاده از این انواع، باید APIهای مربوطه را در کنسول توسعه دهندگان گوگل فعال کنید.

سرویس روش‌های API Awareness API برای فعال کردن
چراغ های دریایی SnapshotApi.getBeaconState() , FenceApi.BeaconFence Nearby Messages API