ثبت‌نام و کلیدهای میانای برنامه‌سازی کاربردی

اعلان منسوخ شدن: Awareness API منسوخ شده است.

هشدار: Awareness API منسوخ شده است.

• «خدمات Google Play» در نسخه آتی، که ممکن است در ژانویه ۲۰۲۷ منتشر شود، دیگر از Awareness API پشتیبانی نخواهد کرد.
• جایگزین مستقیمی وجود ندارد.

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

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

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

برای دریافت کلید برای برنامه‌تان، باید چند مرحله را انجام دهید. این مراحل به‌طور مفصل در این راهنما شرح داده شده‌اند و به‌صورت زیر خلاصه می‌شوند:

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

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

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

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

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

گواهینامه اشکال‌زدایی

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

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

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

   • OS X و Linux: ~/.android/
   • Windows Vista و Windows 7: C:\Users\your_user_name\.android\

2. اثر انگشت اس‌اچ‌اِی-۱ را فهرست کنید:

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

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

   • برای Windows Vista و Windows 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. فایل keystore گواهی انتشار را پیدا کنید. مکان یا نام پیش‌فرضی برای keystore نسخه پخش وجود ندارد. اگر هنگام ساختن برنامه برای انتشار، آن را مشخص نکنید، ساخت .apk شما را بدون امضا رها می‌کند و باید آن را امضا کنید تا بتوانید آن را منتشر کنید. برای گواهینامه انتشار، به نام مستعار گواهینامه، گذرواژه‌های keystore، و گواهینامه نیز نیاز دارید.

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

   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 گواهینامه است. اثر انگشت دنباله‌ای از ۲۰ عدد شانزده‌شانزدهی دورقمی است که با دونقطه از هم جدا شده‌اند.

احتیاط: برای محافظت از کلید و مخزن کلید، آرگومان‌های storepass یا keypass را در خط فرمان وارد نکنید، مگراینکه از امنیت رایانه‌تان مطمئن باشید. برای مثال، در رایانه عمومی، فردی می‌تواند به فهرست فرایندهای درحال اجرا یا سابقه پنجره ترمینال شما نگاه کند، گذرواژه را دریافت کند، و سپس به گواهی امضای شما دسترسی نوشتن داشته باشد. این کار به آن شخص اجازه می‌دهد برنامه شما را اصلاح کند یا برنامه خودش را جایگزین آن کند.

دریافت کلید میانای برنامه‌سازی کاربردی از Google Developers Console

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

دریافت کلید

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

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

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

   توجه: اگر کلید Android موجودی دارید، می‌توانید از آن استفاده کنید.

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 جدیدتان در فهرست کلیدهای میانای برنامه‌سازی کاربردی پروژه‌تان نشان داده می‌شود. کلید میانای برنامه‌سازی کاربردی رشته‌ای از نویسه‌ها است، مانند:

   AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0
   

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

فعال کردن میاناهای برنامه‌سازی کاربردی دیگر

‫Awareness API به شما امکان می‌دهد به چندین نوع داده زمینه‌ای، مانند فانوس‌ها، دسترسی داشته باشید. برای استفاده از این نوع‌ها، باید APIهای مربوطه را در «کنسول Google Developers» فعال کنید.

سرویس	روش‌های Awareness API	میانای برنامه‌سازی کاربردی برای فعال کردن
نشان‌فرست‌ها	SnapshotApi.getBeaconState()، FenceApi.BeaconFence	Nearby Messages API