הגדרת OAuth לאפליקציה ל-Android

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

אם כבר יש לכם לקוח OAuth מאומת (לדוגמה, מאפליקציה שכבר פורסמה), אתם יכולים להשתמש בלקוח הזה כדי לבדוק את ממשקי ה-API של Home בלי להגדיר לקוח חדש. אם יש לכם לקוח OAuth קיים

חתימה על האפליקציה

קודם כל, יוצרים אישור לניפוי באגים על ידי הפעלת האפליקציה ב-Android Studio. כשמפעילים אפליקציה או מנפים בה באגים ב-Android Studio, נוצר באופן אוטומטי אישור לניפוי באגים שמיועד לפיתוח ולניפוי באגים. הסבר מלא זמין במאמר Android Studio: Sign your debug build.

אחרי שהאפליקציה פועלת:

  1. מחברים את המכשיר הנייד למחשב המקומי. ב-Android Studio תופיע רשימה של המכשירים המחוברים לפי מספר הדגם. בוחרים את המכשיר מהרשימה ולוחצים על Run project. הפעולה הזו יוצרת ומתקינה את האפליקציה לדוגמה במכשיר הנייד.

    הוראות מפורטות יותר זמינות במאמר Run apps on a hardware device באתר מפתחי Android.

  2. עוצרים את האפליקציה שפועלת.

  3. כדי לקבל את טביעת האצבע SHA-1 של האישור לניפוי באגים, פועלים לפי ההוראות שמפורטות במאמר הגדרת OAuth 2.0 / אפליקציות נייטיב / Android באתר העזרה של מסוף Google Cloud.

  1. במסוף Google Cloud, נכנסים למרכז הבקרה לבחירת פרויקט ובוחרים את הפרויקט שבו רוצים ליצור את פרטי הכניסה ל-OAuth.
  2. נכנסים לדף APIs and Services ולוחצים על Credentials בתפריט הניווט.
  3. אם עדיין לא הגדרתם את מסך ההסכמה לפרויקט הזה ב-Google Cloud, יופיע הכפתור Configure consent screen. במקרה כזה, מגדירים את מסך ההסכמה לפי ההוראות הבאות. אם לא, עוברים לקטע הבא.

    1. לוחצים על Configure consent screen. נפתח הדף OAuth consent screen.
    2. בהתאם לתרחיש השימוש, בוחרים באפשרות Internal או External ולוחצים על Create. מופיע החלונית מסך הסכמה של OAuth.
    3. מזינים את המידע בדף פרטי האפליקציה לפי ההוראות במסך, ולוחצים על שמירה והמשך. החלונית Scopes נפתחת.
    4. אין צורך להוסיף היקפי הרשאות, אז לוחצים על שמירה והמשך. החלונית Test users מוצגת.
    5. לוחצים על קהל ואז על הכפתור + הוספת משתמשים.
    6. מזינים את כתובת האימייל של משתמש הבדיקה ולוחצים על הכפתור שמירה.
    7. לוחצים על שמירה והמשך. החלונית Summary נפתחת.
    8. בודקים את הפרטים במסך ההסכמה ל-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.

כשהמכשיר הנייד מחובר למכונה המקומית, בוחרים את המכשיר מהרשימה ולוחצים שוב על Run project כדי להריץ אותו. הוראות מפורטות יותר זמינות במאמר Run apps on a hardware device באתר מפתחי Android.

אם יש לכם לקוח OAuth קיים

אם כבר יש לכם לקוח OAuth מאומת לאפליקציה שפורסמה, אתם יכולים להשתמש בלקוח הקיים של OAuth כדי לבדוק את ממשקי ה-API של Home.

לא צריך להירשם ל-Google Home Developer Console כדי לבדוק את ממשקי ה-API של Home ולהשתמש בהם. עם זאת, עדיין תצטרכו רישום מאושר של Developer Console כדי לפרסם את האפליקציה, גם אם יש לכם לקוח OAuth מאומת משילוב אחר.

צריך להתחשב בשיקולים הבאים:

  • יש מגבלה של 100 משתמשים כשמשתמשים בלקוח OAuth קיים. במאמרהגדרת מסך ההסכמה של OAuth. בלי קשר לאימות OAuth, יש מגבלה של 100 משתמשים שיכולים לתת הרשאות לאפליקציה שלכם, שנקבעת על ידי ממשקי ה-API של Home. ההגבלה הזו תוסר אחרי השלמת הרישום של Developer Console.

  • Developer Console registration צריך לשלוח לאישור כשמוכנים להגביל את ההרשאות של סוגי המכשירים באמצעות OAuth כהכנה לעדכון האפליקציה באמצעות ממשקי ה-API של Home.

ב-Google Cloud אפליקציות שעדיין ממתינות לאימות OAuth, המשתמשים לא יכולים להשלים את תהליך ה-OAuth עד שהאימות יושלם. אם תנסו לתת הרשאות, תופיע הודעת השגיאה הבאה:

Access blocked: <Project Name> has not completed the Google verification process.