راه‌اندازی OAuth برای برنامه Android

Home APIs از OAuth 2.0 برای اعطای دسترسی به دستگاه‌ها در ساختار استفاده می‌کند. ‫OAuth به کاربر اجازه می‌دهد بدون نیاز به افشای اعتبارنامه ورود به سیستم خود، به برنامه یا سرویسی اجازه دسترسی بدهد.

اگر ازقبل کارخواه OAuth درستی‌سنجی‌شده دارید (برای مثال، از برنامه‌ای که قبلاً منتشر شده است)، می‌توانید از آن کارخواه برای آزمایش Home API بدون راه‌اندازی کارخواه جدید استفاده کنید. برای اطلاعات بیشتر، به اگر کارخواه OAuth موجود دارید مراجعه کنید.

امضا کردن برنامه

ابتدا با اجرای برنامه‌تان در Android Studio، گواهینامه اشکال‌زدایی تولید کنید. وقتی برنامه‌ای را در Android Studio اجرا یا اشکال‌زدایی می‌کنید، به‌طور خودکار گواهینامه اشکال‌زدایی‌ای تولید می‌کند که برای توسعه و اشکال‌زدایی درنظر گرفته شده است. برای توضیحات کامل، استودیو Android: امضای ساخت اشکال‌زدایی را ببینید.

وقتی برنامه درحال اجرا است:

  1. دستگاه همراهتان را به دستگاه محلی‌تان متصل کنید. Android Studio دستگاه‌های متصل‌شده شما را براساس شماره مدل فهرست می‌کند. دستگاهتان را از فهرست انتخاب کنید، سپس روی اجرای پروژه کلیک کنید. این کار «برنامه نمونه» را در دستگاه همراهتان می‌سازد و نصب می‌کند.

    برای دستورالعمل‌های دقیق‌تر، به اجرای برنامه‌ها در دستگاه سخت‌افزاری در سایت «توسعه‌دهندگان Android» مراجعه کنید.

  2. برنامه درحال اجرا را متوقف کنید.

  3. با دنبال کردن دستورالعمل‌های شرح‌داده‌شده در راه‌اندازی OAuth 2.0 / برنامه‌های بومی / Android در سایت راهنمای Google Cloud Console، اثر انگشت SHA-1 گواهینامه اشکال‌زدایی را دریافت کنید.

  1. در کنسول Google Cloud، به داشبورد انتخابگر پروژه بروید و پروژه‌ای را که می‌خواهید برای ایجاد اطلاعات کاربری OAuth استفاده کنید انتخاب کنید.
  2. به صفحه میاناهای برنامه‌سازی کاربردی و سرویس‌ها بروید و در منو پیمایش روی اطلاعات کاربری کلیک کنید.
  3. اگر هنوز صفحه رضایت را برای این پروژه Google Cloud پیکربندی نکرده‌اید، دکمه پیکربندی صفحه رضایت نشان داده می‌شود. در این صورت، صفحه رضایتتان را بااستفاده از روال زیر پیکربندی کنید. درغیراین‌صورت، به بخش بعدی بروید.

    1. روی پیکربندی صفحه رضایت کلیک کنید. صفحه صفحه رضایت OAuth نمایش داده می‌شود.
    2. بسته به مورد استفاده‌تان، داخلی یا خارجی را انتخاب کنید، و سپس روی ایجاد کلیک کنید. صفحه صفحه کسب رضایت OAuth نمایش داده می‌شود.
    3. اطلاعات را طبق دستورالعمل‌های روی صفحه در صفحه اطلاعات برنامه وارد کنید و سپس روی ذخیره و ادامه کلیک کنید. صفحه گستره‌ها نمایش داده می‌شود.
    4. نیازی به افزودن هیچ دامنه‌ای نیست، بنابراین روی ذخیره و ادامه کلیک کنید. پانل کاربران آزمایشی نمایش داده می‌شود.
    5. روی مخاطب کلیک کنید و روی دکمه + افزودن کاربران کلیک کنید.
    6. نشانی ایمیل کاربر آزمایشی را وارد کنید و روی دکمه ذخیره کلیک کنید.
    7. روی ذخیره کردن و ادامه دادن کلیک کنید. قاب خلاصه نمایش داده می‌شود.
    8. اطلاعات صفحه کسب رضایت OAuth را مرور کنید و سپس روی برگشتن به داشبورد کلیک کنید.

برای جزئیات کامل، به راه‌اندازی صفحه رضایت 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 API استفاده کنید.

برای آزمایش و استفاده از Home API، ثبت‌نام Google Home Developer Console لازم نیست. بااین‌حال، برای انتشار برنامه‌تان همچنان به ثبت تأییدشده Developer Console نیاز دارید، حتی اگر کارخواه OAuth درستی‌سنجی‌شده‌ای از ادغام دیگری داشته باشید.

ملاحظات زیر اعمال می‌شود:

  • هنگام استفاده از کارخواه OAuth موجود، محدودیت ۱۰۰ کاربر وجود دارد. برای کسب اطلاعات درباره افزودن کاربران آزمایشی، به صفحه کسب رضایت OAuth را راه‌اندازی کنید. مستقل از درستی‌سنجی OAuth، محدودیتی ازسوی Home APIs اعمال می‌شود که فقط ۱۰۰ کاربر می‌توانند به برنامه شما اجازه اعطا کنند. این محدودیت پس‌از تکمیل ثبت‌نام Developer Console برداشته می‌شود.

  • Developer Console ثبت‌نام باید زمانی برای تأیید ارسال شود که آماده باشید اعطای دسترسی به نوع دستگاه را ازطریق OAuth محدود کنید تا برای به‌روزرسانی برنامه‌تان با Home API آماده شوید.

برای Google Cloud برنامه‌ای که هنوز درستی‌سنجی OAuth آن‌ها معلق است، کاربران نمی‌توانند جریان OAuth را تا زمانی که درستی‌سنجی تکمیل شود کامل کنند. تلاش برای اعطای اجازه‌ها با خطای زیر ناموفق خواهد بود:

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