מפתחות הרשמה ו-API

כדי להשתמש ב-Google Awareness API, עליכם להוסיף לאפליקציה מפתח Google API. סוג מפתח ה-API הנדרש הוא מפתח API ל-Android.

כל האפליקציות ל-Android חתומות באמצעות אישור דיגיטלי שעבורו יש לכם את המפתח הפרטי. למידע נוסף על אישורים דיגיטליים, קראו את המדריך לחתימת האפליקציה ב-Android.

מפתחות Android API מקושרים לזוגות ספציפיים של חבילות אישורים. לכל מפתח צריך רק מפתח אחד, לא משנה כמה משתמשים יש לאפליקציה.

כדי לקבל מפתח לאפליקציה נדרשים כמה שלבים. הם מתוארים בפירוט במדריך הזה ובסיכום שלהם:

  1. קבלת מידע על האישור של האפליקציה.
  2. רושמים פרויקט במסוף Google Developers ומוסיפים את ממשק ה-API של הקשר המשתמשים כשירות לפרויקט.
  3. מבקשים מפתח.
  4. צריך להוסיף את המפתח לאפליקציה. כדי לעשות זאת, צריך להוסיף רכיב לקובץ המניפסט של האפליקציה.

איך מוצאים את פרטי האישור של האפליקציה

מפתח ה-API מבוסס על צורה קצרה של האישור הדיגיטלי של האפליקציה, שמכונה טביעת אצבע SHA-1. כדי להציג את טביעת האצבע SHA-1 עבור האישור שלך, קודם צריך לוודא שהשתמשת באישור הנכון. אתם יכולים לבחור מבין שני האישורים הבאים:

  • אישור לניפוי באגים: הכלי הזה ל-Android SDK יוצר את האישור הזה באופן אוטומטי כשיוצרים build לניפוי באגים. יש להשתמש באישור הזה רק באפליקציות שבודקים. אין לנסות לפרסם אפליקציה שחתומה באמצעות אישור ניפוי באגים. האישור על ניפוי הבאגים מתואר בפירוט בקטע חתימה על ניפוי הבאגים במסמכי התיעוד למפתחים של Android.
  • אישור גרסה: אישור ה-SDK של הכלים ל-Android יוצר את גרסת ה-build. אפשר ליצור את האישור הזה גם באמצעות התוכנית keytool. יש להשתמש באישור הזה כשרוצים להפיץ את האפליקציה ברחבי העולם.

למידע נוסף על keytool, קראו את מסמכי התיעוד של Oracle.

אישור לניפוי באגים

הצגת טביעת האצבע של אישור ניפוי הבאגים

יש להשתמש בתוכנה keytool עם הפרמטר -v כדי להציג את טביעת האצבע SHA-1 של האישור. כדי לעשות זאת:

  1. מאתרים את קובץ מאגר המפתחות של ניפוי הבאגים. שם הקובץ הוא debug.keystore, והוא נוצר בפעם הראשונה כשבונים את הפרויקט. כברירת מחדל, הקובץ מאוחסן באותה ספרייה של קובצי מכשיר וירטואלי (AVD) ב-Android:

    • 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 Windows ו-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. מאתרים את קובץ מאגר המפתחות של אישור הגרסה. אין מיקום או שם ברירת מחדל למאגר מפתחות הגרסה. אם לא בחרת גרסה כשבונים את האפליקציה כדי לפרסם אותה, ה-build נותר ללא חתימה ב-.apk וצריך לחתום עליו לפני שאפשר לפרסם אותו. עבור אישור הגרסה, דרושים גם הכינוי של האישור, הסיסמאות של מאגר המפתחות והאישור.

  2. כדי לרשום את הכינויים של כל המפתחות במאגר מפתחות, יש להזין את הפרטים הבאים:

    keytool -list -keystore your_keystore_name
  3. מחליפים את your_keystore_name בנתיב המלא ובשם של מאגר המפתחות. יש לכלול את התוסף .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 של האישור. טביעת האצבע היא רצף של 20 מספרים הקסדצימליים בני שתי ספרות שמופרדים בנקודתיים.

אפשר לקבל מפתח API מ-Google Developers Console

כדי להתחיל להשתמש ב-Google Awareness API, לוחצים על הלחצן Get a key. הוא מקשר ל-Google Developers Console, שמנחה אתכם בתהליך ומפעיל את Awareness API באופן אוטומטי.

קבלת מפתח

לחלופין, אפשר לבצע את הפעולות הבאות כדי לקבל מפתח API:

  1. נכנסים אל Google Developers Console.
  2. בוחרים פרויקט או יוצרים פרויקט חדש.
  3. לוחצים על Continue (המשך) כדי להפעיל את Awareness API.

  4. בדף Credentials, יוצרים מפתח ל-Android ומגדירים את פרטי הכניסה ל-API.

  5. בתיבת הדו-שיח 'Create key', צריך להגביל את השימוש לאפליקציות ל-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. לוחצים על Create (יצירה). מפתח ה-API החדש של Android מופיע ברשימת מפתחות ה-API של הפרויקט. מפתח API הוא מחרוזת של תווים, כגון:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0

אחרי שתקבלו מפתח API, תוכלו להוסיף אותו למניפסט של האפליקציה, כפי שמוסבר במדריך תחילת העבודה.

הפעלת ממשקי API נוספים

ה-API של המודעות מאפשר לגשת לסוגים רבים של נתוני הקשר, כמו אלומות. כדי להשתמש בסוגים האלה, צריך להפעיל את ממשקי ה-API המתאימים ב-Google Developers Console.

שירות שיטות של Aware Aware API API להפעלה
חיישנים SnapshotApi.getBeaconState(), FenceApi.BeaconFence API של Messages בקרבת מקום