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

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

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

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

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

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

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

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

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

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

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

  4. موارد زیر را در پایانه یا خط فرمان وارد کنید:

          keytool -list -v -keystore your_keystore_name -alias your_alias_name
  5. your_keystore_name را با مسیر و نام کاملاً واجدشرایط انبار کلید جایگزین کنید. افزونه .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 گواهی است. اثر انگشت توالی ۲۰ عدد هگزادسیمال دورقمی است که با دونقطه از هم جدا شده‌اند.

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

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

دریافت کلید

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

  1. به Google Developers Console بروید.
  2. پروژه‌ای را انتخاب کنید یا پروژه جدیدی بسازید.
  3. برای فعال کردن «میانای برنامه‌سازی کاربردی آگاهی»، روی ادامه کلیک کنید.

  4. در صفحه «اعتبارنامه‌ها»، کلید 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 دارید، می‌توانید آن را به مانیفست برنامه‌تان اضافه کنید، همان‌طور که در راهنمای شروع به کار توضیح داده شده است.

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

«میانای برنامه‌سازی کاربردی آگاهی» به شما امکان می‌دهد به انواع مختلفی از داده‌های زمینه‌ای، مانند فرستنده‌های بی‌سیم، دسترسی داشته باشید. برای استفاده از این نوع‌ها، باید واسط‌های برنامه‌سازی کاربردی مربوطه را در «کنسول Google Developers» فعال کنید.

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