رابط‌های برنامه‌نویسی کاربردی (API) خانه (Home APIs) از OAuth 2.0 برای اعطای دسترسی به دستگاه‌های موجود در ساختار استفاده می‌کنند. OAuth به کاربر اجازه می‌دهد بدون نیاز به افشای اطلاعات ورود به سیستم، به یک برنامه یا سرویس مجوز دهد.
اگر از قبل یک کلاینت OAuth تأیید شده دارید (مثلاً از یک برنامه منتشر شده)، می‌توانید از آن کلاینت برای آزمایش APIهای Home بدون تنظیم یک کلاینت جدید استفاده کنید. برای اطلاعات بیشتر، به بخش «اگر یک کلاینت OAuth موجود دارید» مراجعه کنید.
برنامه را امضا کنید
ابتدا، با اجرای برنامه خود در Android Studio ، یک گواهی اشکال‌زدایی (debug certificate) ایجاد کنید. وقتی برنامه‌ای را در Android Studio اجرا یا اشکال‌زدایی می‌کنید، اندروید استودیو به طور خودکار یک گواهی اشکال‌زدایی (debug certificate) برای توسعه و اشکال‌زدایی تولید می‌کند. برای توضیح کامل به Android Studio: Sign your debug build مراجعه کنید.
پس از اجرای برنامه:
دستگاه تلفن همراه خود را به دستگاه محلی خود وصل کنید. Android Studio دستگاه‌های متصل شما را بر اساس شماره مدل فهرست می‌کند. دستگاه خود را از لیست انتخاب کنید، سپس روی اجرای پروژه کلیک کنید. این کار باعث ایجاد و نصب برنامه نمونه روی دستگاه تلفن همراه شما می‌شود.
برای دستورالعمل‌های دقیق‌تر، به بخش «اجرای برنامه‌ها روی دستگاه سخت‌افزاری» در سایت توسعه‌دهندگان اندروید مراجعه کنید.
برنامه در حال اجرا را متوقف کنید.
با دنبال کردن دستورالعمل‌های شرح داده شده در بخش راه‌اندازی OAuth 2.0 / برنامه‌های بومی / اندروید در سایت راهنمای کنسول ابری گوگل، اثر انگشت SHA-1 گواهی اشکال‌زدایی را دریافت کنید.
صفحه رضایت OAuth را تنظیم کنید
- در کنسول گوگل کلود، به داشبورد انتخاب پروژه بروید و پروژه‌ای را که می‌خواهید برای ایجاد اعتبارنامه‌های OAuth از آن استفاده کنید، انتخاب کنید.
- به صفحه APIها و خدمات بروید و در منوی پیمایش روی اعتبارنامه‌ها کلیک کنید.
اگر هنوز صفحه رضایت خود را برای این پروژه Google Cloud پیکربندی نکرده‌اید، دکمه پیکربندی صفحه رضایت ظاهر می‌شود. در این صورت، صفحه رضایت خود را با استفاده از روش زیر پیکربندی کنید. در غیر این صورت، به بخش بعدی بروید.
- روی صفحه پیکربندی رضایت کلیک کنید. صفحه صفحه رضایت OAuth نمایش داده می‌شود.
- بسته به مورد استفاده شما، داخلی (Internal ) یا خارجی (External) را انتخاب کنید و سپس روی ایجاد (Create) کلیک کنید. صفحه رضایت OAuth نمایش داده می‌شود.
- طبق دستورالعمل‌های روی صفحه، اطلاعات را در صفحه اطلاعات برنامه وارد کنید و سپس روی ذخیره و ادامه کلیک کنید. پنجره Scopes نمایش داده می‌شود.
- نیازی به اضافه کردن هیچ محدوده‌ای ندارید، بنابراین روی ذخیره و ادامه کلیک کنید. پنجره‌ی کاربران آزمایشی نمایش داده می‌شود.
- روی مخاطب کلیک کنید و دکمه + افزودن کاربر را بزنید.
- آدرس ایمیل کاربر آزمایشی خود را وارد کنید و روی دکمه ذخیره کلیک کنید.
- روی ذخیره و ادامه کلیک کنید. پنجره خلاصه نمایش داده می‌شود.
- اطلاعات صفحه رضایت OAuth خود را مرور کنید و سپس روی «بازگشت به داشبورد» کلیک کنید.
برای جزئیات کامل، به بخش «تنظیم صفحه رضایت OAuth» در سایت راهنمای کنسول ابری گوگل مراجعه کنید.
برنامه را ثبت کنید و اعتبارنامه ایجاد کنید
برای ثبت برنامه برای OAuth 2.0 و ایجاد اعتبارنامه‌های OAuth، دستورالعمل‌های ارائه شده در بخش راه‌اندازی OAuth 2.0 را دنبال کنید. باید نوع برنامه را که native/Android app است، مشخص کنید.
اثر انگشت SHA-1 که از امضای برنامه دریافت کرده‌اید را با دنبال کردن دستورالعمل‌های موجود در بخش «راه‌اندازی برنامه‌های OAuth 2.0 / Native» در سایت راهنمای کنسول Google Cloud، به کلاینت OAuth که در کنسول Google Cloud راه‌اندازی کرده‌اید، اضافه کنید.
در حالی که دستگاه همراهتان به دستگاه محلی‌تان متصل است، دستگاه خود را از لیست انتخاب کنید، سپس دوباره روی اجرای پروژه کلیک کنید تا اجرا شود. برای دستورالعمل‌های دقیق‌تر، به بخش اجرای برنامه‌ها روی دستگاه سخت‌افزاری در سایت توسعه‌دهندگان اندروید مراجعه کنید.
اگر یک کلاینت OAuth موجود دارید
اگر از قبل یک کلاینت OAuth تأیید شده برای یک برنامه منتشر شده دارید، می‌توانید از کلاینت OAuth موجود خود برای آزمایش APIهای Home استفاده کنید.
برای آزمایش و استفاده از APIهای Home، ثبت نام Google Home Developer Console الزامی نیست. با این حال، برای انتشار برنامه خود، حتی اگر یک کلاینت OAuth تأیید شده از یک ادغام دیگر داشته باشید، همچنان به یک ثبت نام تأیید شده Developer Console نیاز خواهید داشت.
ملاحظات زیر اعمال می‌شود:
هنگام استفاده از یک کلاینت OAuth موجود، محدودیت ۱۰۰ کاربر وجود دارد. برای اطلاعات بیشتر در مورد افزودن کاربران آزمایشی، بهصفحه رضایت OAuth را تنظیم کنید .مستقل از تأیید OAuth، محدودیت ۱۰۰ کاربر از طرف Home APIs وجود دارد که می‌توانند به برنامه شما مجوز اعطا کنند. این محدودیت پس از تکمیل ثبت نام در Developer Console برداشته می‌شود.
ثبت نام Developer Console باید زمانی که آماده محدود کردن اعطای مجوز به نوع دستگاه از طریق OAuth برای به‌روزرسانی برنامه خود با رابط‌های برنامه‌نویسی کاربردی خانگی هستید، برای تأیید ارسال شود.
برای برنامه‌های Google Cloud که هنوز در انتظار تأیید OAuth هستند، کاربران نمی‌توانند جریان OAuth را تا زمان تکمیل تأیید تکمیل کنند. تلاش برای اعطای مجوز با خطای زیر شکست خواهد خورد:
Access blocked: <Project Name> has not completed the Google verification process.