ממשקי ה-API של Home משתמשים ב-OAuth 2.0 כדי להעניק גישה למכשירים במבנה. פרוטוקול OAuth מאפשר למשתמש להעניק הרשאה לאפליקציה או לשירות בלי לחשוף את פרטי הכניסה שלו.
אם כבר יש לכם לקוח OAuth מאומת (למשל, מאפליקציה שכבר פורסמה), אתם יכולים להשתמש בלקוח הזה כדי לבדוק את ממשקי ה-API של Home בלי להגדיר לקוח חדש. מידע נוסף זמין במאמר אם יש לכם לקוח OAuth קיים.
חתימה על האפליקציה
קודם כול, מריצים את האפליקציה ב-Android Studio כדי ליצור אישור לניפוי באגים. כשמריצים או מנפים באגים באפליקציה ב-Android Studio, המערכת יוצרת באופן אוטומטי אישור ניפוי באגים שמיועד לפיתוח ולניפוי באגים. הסבר מפורט זמין במאמר Android Studio: Sign your debug build.
אחרי שהאפליקציה פועלת:
מחברים את הנייד למחשב המקומי. ברשימה Android Studio יופיעו המכשירים המחוברים לפי מספר הדגם. בוחרים את המכשיר מהרשימה ולוחצים על הפעלת הפרויקט. הפעולה הזו יוצרת את אפליקציית הדוגמה ומתקינה אותה במכשיר הנייד.
הוראות מפורטות זמינות במאמר Run apps on a hardware device באתר Android Developers.
מפסיקים את האפליקציה הפעילה.
פועלים לפי ההוראות שמפורטות במאמר הגדרה של OAuth 2.0 / אפליקציות מקוריות / Android באתר העזרה של Google Cloud Console כדי לקבל את טביעת האצבע של אישור הניפוי באגים בפורמט SHA-1.
הגדרת מסך ההסכמה ל-OAuth
- במסוף Google Cloud, עוברים אל מרכז הבקרה לבחירת פרויקט ובוחרים את הפרויקט שבו רוצים להשתמש כדי ליצור פרטי כניסה ל-OAuth.
- עוברים לדף APIs and Services (ממשקי API ושירותים) ולוחצים על Credentials (פרטי כניסה) בתפריט הניווט.
אם עדיין לא הגדרתם את מסך ההסכמה לפרויקט הזה ב-Google Cloud, יופיע הלחצן Configure consent screen (הגדרת מסך ההסכמה). במקרה כזה, צריך להגדיר את מסך ההסכמה באמצעות התהליך הבא. אחרת, עוברים לקטע הבא.
- לוחצים על הגדרת מסך ההסכמה. מוצג הדף מסך הסכמה ל-OAuth.
- בהתאם לתרחיש השימוש, בוחרים באפשרות פנימי או חיצוני ולוחצים על יצירה. מוצגת החלונית מסך הסכמה ל-OAuth.
- מזינים את המידע בדף פרטי האפליקציה בהתאם להוראות במסך, ואז לוחצים על שמירה והמשך. החלונית Scopes מוצגת.
- אין צורך להוסיף היקפי הרשאה, אז לוחצים על שמירה והמשך. החלונית משתמשי בדיקה מוצגת.
- לוחצים על קהל ואז על הלחצן + הוספת משתמשים.
- מזינים את כתובת האימייל של משתמש הבדיקה ולוחצים על הלחצן שמירה.
- לוחצים על שמירה והמשך. מוצגת החלונית סיכום.
- בודקים את המידע במסך ההסכמה ל-OAuth ולוחצים על חזרה ללוח הבקרה.
פרטים מלאים זמינים במאמר הגדרת מסך הסכמה ל-OAuth באתר העזרה של Google Cloud Console.
רישום האפליקציה ויצירת פרטי כניסה
כדי לרשום את האפליקציה ל-OAuth 2.0 וליצור פרטי כניסה ל-OAuth, פועלים לפי ההוראות במאמר הגדרת OAuth 2.0. תצטרכו לציין את סוג האפליקציה, שהוא אפליקציה מקורית/אפליקציית Android.
מוסיפים את טביעת האצבע של SHA-1 שקיבלתם מחתימה על האפליקציה ללקוח OAuth שהגדרתם במסוף Google Cloud. לשם כך, פועלים לפי ההוראות במאמר הגדרה של OAuth 2.0 / אפליקציות מקומיות באתר העזרה של Google Cloud Console.
אחרי שמחברים את המכשיר הנייד למחשב המקומי, בוחרים את המכשיר מהרשימה ולוחצים שוב על הרצת הפרויקט כדי להריץ אותו. הוראות מפורטות יותר זמינות במאמר הרצת אפליקציות במכשיר חומרה באתר למפתחי Android.
אם יש לכם לקוח OAuth קיים
אם כבר יש לכם לקוח OAuth מאומת לאפליקציה שפורסמה, אתם יכולים להשתמש בלקוח ה-OAuth הקיים כדי לבדוק את ממשקי ה-API של Home.
אין צורך ברישום Google Home Developer Console כדי לבדוק את ממשקי ה-API של Home ולהשתמש בהם. עם זאת, עדיין תצטרכו רישום מאושר של Developer Console כדי לפרסם את האפליקציה, גם אם יש לכם לקוח OAuth מאומת משילוב אחר.
צריך להתחשב בשיקולים הבאים:
קיימת מגבלה של 100 משתמשים כשמשתמשים בלקוח OAuth קיים. מידע על הוספת משתמשים למטרות בדיקה זמין במאמר בנושאהגדרת מסך ההסכמה של OAuth. בנוסף לאימות OAuth, יש מגבלה של 100 משתמשים שיכולים להעניק הרשאות לאפליקציה שלכם, שמוגדרת על ידי Home APIs. המגבלה הזו תוסר לאחר השלמת הרישום של Developer Console.
Developer Console registration צריך לשלוח לאישור כשמוכנים להגביל הרשאות לפי סוג המכשיר באמצעות OAuth, כהכנה לעדכון האפליקציה באמצעות ממשקי ה-API של Home.
באפליקציות Google Cloud שעדיין בהמתנה לאימות OAuth, המשתמשים לא יכולים להשלים את תהליך OAuth עד שהאימות יושלם. ניסיונות להעניק הרשאות ייכשלו עם השגיאה הבאה:
Access blocked: <Project Name> has not completed the Google verification process.