ממשקי Home API משתמשים ב-OAuth 2.0 כדי להעניק גישה למכשירים במבנה. OAuth מאפשר למשתמש להעניק הרשאה לאפליקציה או לשירות בלי לחשוף את פרטי הכניסה שלו.
אם כבר יש לכם לקוח OAuth מאומת (למשל, מאפליקציה שכבר פורסמה), תוכלו להשתמש בו כדי לבדוק את ממשקי ה-API של Home בלי להגדיר לקוח חדש. מידע נוסף זמין במאמר אם יש לכם לקוח OAuth קיים.
חתימה על האפליקציה
קודם צריך ליצור מפתח OAuth על ידי הפעלת האפליקציה ב-Android Studio. כשמריצים או מאתרים באגים באפליקציה ב-Android Studio, נוצר באופן אוטומטי מפתח OAuth שמיועד לפיתוח ולניפוי באגים. הסבר מלא זמין במאמר Android Studio: חתימה על build לניפוי באגים.
אחרי שהאפליקציה פועלת:
מחברים את המכשיר הנייד למחשב המקומי. Android Studio תציג את המכשירים המקושרים לפי מספר הדגם. בוחרים את המכשיר מהרשימה ולוחצים על הפעלת הפרויקט. הפקודה הזו יוצרת ומתקינה את אפליקציית הדוגמה במכשיר הנייד.
הוראות מפורטות יותר זמינות במאמר הרצת אפליקציות במכשיר חומרה באתר למפתחי Android.
מפסיקים את האפליקציה שפועלת.
כדי לקבל את טביעת האצבע של SHA-1 של אישור ה-OAuth, פועלים לפי ההוראות שמפורטות במאמר הגדרת OAuth 2.0 / אפליקציות מקוריות / Android באתר העזרה של מסוף Google Cloud.
הגדרת מסך ההסכמה ל-OAuth
- במסוף Google Cloud, עוברים אל לוח הבקרה לבחירת פרויקט ובוחרים את הפרויקט שבו רוצים להשתמש כדי ליצור פרטי כניסה ל-OAuth.
- עוברים לדף APIs and Services ולוחצים על Credentials בתפריט הניווט.
אם עדיין לא הגדרתם את מסך ההסכמה לפרויקט הזה ב-Google Cloud, יופיע הלחצן Configure consent screen (הגדרת מסך ההסכמה). במקרה כזה, צריך להגדיר את מסך ההסכמה לפי התהליך הבא. אחרת, עוברים לקטע הבא.
- לוחצים על Configure consent screen (הגדרת מסך ההסכמה). הדף מסך ההסכמה ל-OAuth יוצג.
- בהתאם לתרחיש לדוגמה, בוחרים באפשרות פנימי או חיצוני ולוחצים על Create. החלונית מסך ההסכמה של OAuth תוצג.
- מזינים את הפרטים בדף פרטי האפליקציה לפי ההוראות במסך, ולוחצים על שמירה והמשך. החלונית Scopes תוצג.
- אין צורך להוסיף היקפי גישה, לכן לוחצים על Save and continue (שמירה והמשך). החלונית משתמשי בדיקה תוצג.
- אם רוצים להוסיף משתמשים כדי לבדוק את הגישה לאפליקציה, לוחצים על הוספת משתמשים. החלונית Add users תופיע. למשתמשים לבדיקה יש הרשאה להעניק הרשאות באפליקציה.
- בשדה הריק, מוסיפים כתובת אימייל אחת או יותר של חשבון Google ולוחצים על Add.
- לוחצים על שמירה והמשך. החלונית Summary תופיע.
- בודקים את המידע במסך ההסכמה ל-OAuth ולוחצים על Back to dashboard.
פרטים מלאים זמינים במאמר הגדרת מסך הסכמה ל-OAuth באתר העזרה של מסוף Google Cloud.
רישום האפליקציה ויצירת פרטי כניסה
כדי לרשום את האפליקציה ל-OAuth 2.0 וליצור פרטי כניסה ל-OAuth, פועלים לפי ההוראות שמפורטות במאמר הגדרת OAuth 2.0. צריך לציין את סוג האפליקציה, שהוא אפליקציה מקורית/ל-Android.
מוסיפים את טביעת האצבע מסוג SHA-1 שקיבלתם מחתימה על האפליקציה ללקוח OAuth שהגדרתם במסוף Google Cloud. לשם כך, פועלים לפי ההוראות במאמר הגדרת OAuth 2.0 / אפליקציות מקוריות באתר העזרה של מסוף Google Cloud.
כשהמכשיר הנייד מחובר למחשב המקומי, בוחרים את המכשיר מהרשימה ולוחצים שוב על הפעלת הפרויקט כדי להפעיל אותו. להוראות מפורטות יותר, אפשר לעיין במאמר הרצת אפליקציות במכשיר חומרה באתר למפתחי Android.
אם יש לכם לקוח OAuth קיים
אם כבר יש לכם לקוח OAuth מאומת לאפליקציה שפורסמה, תוכלו להשתמש בלקוח OAuth הקיים כדי לבדוק את Home APIs.
לא צריך להירשם ל-Google Home Developer Console כדי לבדוק את ממשקי ה-API של Home ולהשתמש בהם. עם זאת, עדיין תצטרכו הרשמה מאושרת ב-Developer Console כדי לפרסם את האפליקציה, גם אם יש לכם לקוח OAuth מאומת משילוב אחר.
יש להביא בחשבון את השיקולים הבאים:
כשמשתמשים בלקוח OAuth קיים, יש מגבלה של 100 משתמשים. מידע נוסף על הוספת משתמשים לצורך בדיקה זמין במאמר הגדרת מסך ההסכמה ל-OAuth. ללא קשר לאימות OAuth, יש מגבלה של 100 משתמשים שיכולים להעניק הרשאות לאפליקציה שלכם, והיא מוגדרת על ידי ממשקי ה-API של Home. ההגבלה הזו תוסר לאחר השלמת הרישום ב-Developer Console.
Developer Console רישום צריך לשלוח לאישור כשאתם מוכנים להגביל את ההרשאות לפי סוג המכשיר באמצעות OAuth, לקראת עדכון האפליקציה באמצעות ממשקי ה-API של Home.
באפליקציות Google Cloud שעדיין בהמתנה לאימות OAuth, המשתמשים לא יכולים להשלים את תהליך OAuth עד שהאימות יושלם. ניסיונות להקצות הרשאות ייכשלו עם השגיאה הבאה:
Access blocked: <Project Name> has not completed the Google verification process.