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

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

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

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

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

  1. מאתרים את קובץ מאגר המפתחות לניפוי באגים. שם הקובץ הוא 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. מזינים את הסיסמה של מאגר המפתחות כשמוצגת בקשה לעשות זאת. לאחר מכן, הפקודה 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. בדף "פרטי כניסה", יוצרים מפתח ל-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. לוחצים על יצירה. מפתח ה-API החדש ל-Android מופיע ברשימת מפתחות ה-API של הפרויקט. מפתח API הוא מחרוזת של תווים, כמו:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0

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

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

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

שירות ה-Methods של Awareness API ה-API שרוצים להפעיל
Beacons SnapshotApi.getBeaconState(), FenceApi.BeaconFence Nearby Messages API