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

סקירה כללית

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

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

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

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

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

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

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

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

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

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

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

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

   • 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 Console, מפעילים את Fitness API ומבקשים מזהה לקוח OAuth 2.0.

אם רוצים לקבל הנחיות בתהליך ולהפעיל את Fitness API באופן אוטומטי, לוחצים על

איך מקבלים מזהה לקוח

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

1. עוברים אל מסוף Google API.
2. בוחרים פרויקט או יוצרים פרויקט חדש. שימוש באותו פרויקט בשביל Android ו-REST של האפליקציה שלך.
3. לוחצים על המשך כדי להפעיל את Fitbit API.
4. לוחצים על Go to credentials (מעבר אל פרטי הכניסה).
5. לוחצים על New credentials (פרטי כניסה חדשים) ובוחרים באפשרות OAuth Client ID (מזהה לקוח 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. לוחצים על יצירה. מזהה הלקוח והסוד החדשים של Android OAuth 2.0 מופיעים ברשימת המזהים של הפרויקט. מזהה הלקוח של OAuth 2.0 הוא מחרוזת של תווים, משהו כמו:

   780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com