קבלת מזהה לקוח ב-OAuth 2.0

סקירה

כדי להשתמש ב-Google Fit ל-Android, נדרש מזהה לקוח של OAuth 2.0 לאפליקציות ל-Android.

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

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

יש כמה שלבים לקבלת מזהה לאפליקציה. שלבים אלה מתוארים בהמשך.

1. מאתרים את פרטי האישור של האפליקציה.
2. יוצרים או משנים פרויקט ב-Google API Console.
3. צריך לבקש מזהה לקוח ב-OAuth 2.0.

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

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

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

צריך לפעול לפי השלבים הבאים כדי להציג את טביעת האצבע מסוג SHA-1 של אישור באמצעות התוכנית keytool עם הפרמטר -v. מידע נוסף על Keytool זמין במסמכי התיעוד של Oracle.

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

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

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

   • macOS ו-Linux: ~/.android/
   • Windows Vista ו-Windows 7: C:\Users\your_user_name\.android\

2. מזינים את טביעת האצבע SHA-1:

   • ב-Linux או ב-macOS, פותחים חלון מסוף ומזינים את הפרטים הבאים:

     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

שחרור האישור

הצגת טביעת האצבע של אישור הגרסה

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

   keytool -list -keystore your_keystore_name

   מחליפים את your_keystore_name בנתיב ובשם של מאגר המפתחות המלאים, כולל התוסף .keystore. תוצג לך בקשה להזין את הסיסמה של מאגר המפתחות. לאחר מכן, כל הכינויים יוצגו ב-keytool במאגר המפתחות.

2. הזינו את הפקודה הבאה במסוף או בשורת הפקודה:

   keytool -list -v -keystore your_keystore_name -alias your_alias_name

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

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

בקשת מזהה לקוח של OAuth 2.0 במסוף Google API

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

אם ברצונך לקבל הדרכה לאורך התהליך ולהפעיל את ממשק ה-API של כושר באופן אוטומטי, לחץ על

קבלת Client-ID

לחלופין, ניתן לבצע את השלבים הבאים כדי להפעיל את כושר API במסוף של ממשקי ה-API של Google ולקבל מזהה לקוח של OAuth 2.0.

1. נכנסים אל Google API Console.
2. בוחרים פרויקט קיים או יוצרים פרויקט חדש. צריך להשתמש באותו פרויקט לגרסאות Android ו-REST של האפליקציה.
3. לחצו על המשך כדי להפעיל את כושר API.
4. לוחצים על לפרטי הכניסה.
5. לוחצים על פרטי כניסה חדשים ובוחרים באפשרות מזהה לקוח OAuth.
6. בקטע סוג האפליקציה, בוחרים באפשרות Android.

7. בתיבת הדו-שיח שמופיעה, מזינים את טביעת האצבע ואת שם החבילה מסוג 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.fit-example

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

   780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com