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

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

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

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

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

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

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

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

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

מידע נוסף על keytool זמין במסמכי העזרה של Oracle.

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

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

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

  1. מאתרים את קובץ מאגר המפתחות לניפוי באגים. שם הקובץ הוא debug.keystore, והוא נוצר בפעם הראשונה שאתם מבצעים build לפרויקט. כברירת מחדל, הוא מאוחסן באותה ספריה שבה נמצאים הקבצים של המכשיר הווירטואלי (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 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. כשמוצגת בקשה, מזינים את הסיסמה של מאגר המפתחות. לאחר מכן, 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, לוחצים על הלחצן קבלת מפתח. הוא מקשר אל Google Developers Console, שבו יש הנחיות לתהליך והוא מפעיל את Awareness API באופן אוטומטי.

להזמנת מפתח

אפשר גם לפעול לפי השלבים הבאים כדי לקבל מפתח API:

  1. עוברים אל Google Developers Console.
  2. בוחרים פרויקט או יוצרים פרויקט חדש.
  3. לוחצים על המשך כדי להפעיל את 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. לוחצים על יצירה. מפתח ה-API החדש של Android מופיע ברשימת מפתחות ה-API של הפרויקט. מפתח API הוא מחרוזת של תווים, כמו המחרוזת הבאה:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0

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

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

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

שירות שיטות של Awareness API ‫API להפעלה
Beacons SnapshotApi.getBeaconState(), FenceApi.BeaconFence Nearby Messages API