ממשקי ה-API של Home משתמשים ב-OAuth 2.0 כדי להעניק גישה למכשירים במבנה. פרוטוקול OAuth מאפשר למשתמש להעניק הרשאה לאפליקציה או לשירות בלי לחשוף את פרטי הכניסה שלו.
אם כבר יש לכם לקוח OAuth מאומת (למשל, מאפליקציה שכבר פורסמה), אתם יכולים להשתמש בלקוח הזה כדי לבדוק את ממשקי ה-API של Home בלי להגדיר לקוח חדש. מידע נוסף זמין במאמר בנושא אם יש לכם לקוח OAuth קיים.
חתימה על האפליקציה
קודם צריך ליצור אישור לניפוי באגים על ידי הפעלת האפליקציה ב-Android Studio. כשמפעילים או מנפים באגים באפליקציה ב-Android Studio, המערכת יוצרת באופן אוטומטי אישור לניפוי באגים שמיועד לפיתוח ולניפוי באגים. הסבר מלא מופיע במאמר Android Studio: חתימה על גרסת build לניפוי באגים.
אחרי שהאפליקציה פועלת:
מחברים את הנייד למחשב המקומי. בקטע Android Studio תופיע רשימה של המכשירים המחוברים לפי מספר הדגם. בוחרים את המכשיר מהרשימה ולוחצים על הפעלת הפרויקט. הפעולה הזו יוצרת את אפליקציית הדוגמה ומתקינה אותה במכשיר הנייד.
הוראות מפורטות זמינות במאמר הרצת אפליקציות במכשיר חומרה באתר Android Developers.
מפסיקים את האפליקציה הפעילה.
פועלים לפי ההוראות שמפורטות במאמר הגדרה של OAuth 2.0 / אפליקציות מקוריות / Android באתר העזרה של מסוף Google Cloud כדי לקבל את טביעת האצבע של אישור הניפוי באגים בפורמט SHA-1.
הגדרת מסך ההסכמה ל-OAuth
- במסוף Google Cloud, עוברים אל לוח הבקרה לבחירת הפרויקט ובוחרים את הפרויקט שבו רוצים להשתמש כדי ליצור פרטי כניסה ל-OAuth.
- עוברים לדף APIs and Services (ממשקי API ושירותים) ולוחצים על Credentials (אמצעי אימות) בתפריט הניווט.
אם עדיין לא הגדרתם את מסך ההסכמה לפרויקט הזה ב-Google Cloud, יופיע הלחצן הגדרת מסך ההסכמה. במקרה כזה, צריך להגדיר את מסך ההסכמה באמצעות התהליך הבא. אחרת, עוברים לקטע הבא.
- לוחצים על הגדרת מסך ההסכמה. מוצג הדף מסך ההסכמה ל-OAuth.
- בהתאם לתרחיש השימוש, בוחרים באפשרות פנימי או חיצוני, ואז לוחצים על יצירה. החלונית מסך הסכמה ל-OAuth מוצגת.
- מזינים את המידע בדף פרטי האפליקציה בהתאם להוראות שמופיעות במסך, ואז לוחצים על שמירה והמשך. החלונית Scopes מוצגת.
- לא צריך להוסיף היקפי הרשאה, אז לוחצים על שמירה והמשך. החלונית משתמשי בדיקה מוצגת.
- לוחצים על קהל ואז על הלחצן + הוספת משתמשים.
- מזינים את כתובת האימייל של חשבון למטרות בדיקה ולוחצים על הלחצן שמירה.
- לוחצים על שמירה והמשך. מוצגת החלונית סיכום.
- בודקים את המידע במסך ההסכמה ל-OAuth ולוחצים על חזרה ללוח הבקרה.
פרטים מלאים זמינים במאמר הגדרת מסך הסכמה ל-OAuth באתר העזרה של מסוף Google Cloud.
רישום האפליקציה ויצירת פרטי כניסה
כדי לרשום את האפליקציה ל-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, כהכנה לעדכון האפליקציה באמצעות Home APIs.
באפליקציות Google Cloud שעדיין ממתינות לאימות OAuth, המשתמשים לא יכולים להשלים את תהליך OAuth עד שהאימות יושלם. ניסיונות להעניק הרשאות ייכשלו עם השגיאה הבאה:
Access blocked: <Project Name> has not completed the Google verification process.