إعداد بروتوكول OAuth لتطبيق Android

تستخدم Home APIs بروتوكول OAuth 2.0 لمنح الإذن بالوصول إلى الأجهزة في البنية. يسمح بروتوكول OAuth للمستخدم بمنح الإذن لتطبيق أو خدمة بدون الحاجة إلى الكشف عن بيانات اعتماد تسجيل الدخول.

إذا كان لديك عميل OAuth تم إثبات ملكيته (على سبيل المثال، من تطبيق تم نشره سابقًا)، يمكنك استخدام هذا العميل لاختبار واجهات برمجة تطبيقات Home بدون إعداد عميل جديد. لمزيد من المعلومات، يُرجى الاطّلاع على في حال كان لديك مثبّتًا حاليًا من ملف تعريف برمجة التطبيقات OAuth.

توقيع التطبيق

أولاً، أنشئ مفتاح OAuth من خلال تشغيل تطبيقك في Android Studio. عند تشغيل تطبيق أو تصحيح أخطاءه في Android Studio، يتم إنشاء مفتاح OAuth تلقائيًا مخصّص للتطوير وتصحيح الأخطاء. اطّلِع على Android Studio: توقيع إصدار debugging للحصول على شرح كامل.

بعد تشغيل التطبيق:

  1. وصِّل جهازك الجوّال بجهاز الكمبيوتر. ستعرض Android Studio أجهزتك المتصلة حسب رقم الطراز. اختَر جهازك من القائمة، ثم انقر على تشغيل المشروع. يؤدي ذلك إلى إنشاء نموذج التطبيق وتثبيته على جهازك الجوّال.

    للحصول على تعليمات أكثر تفصيلاً، يُرجى الاطّلاع على مقالة تشغيل التطبيقات على جهاز برمجي على موقع "مطوّرو تطبيقات Android" الإلكتروني.

  2. أوقِف التطبيق الذي يعمل.

  3. احصل على الملف المرجعي SHA-1 لشهادة OAuth من خلال اتّباع التعليمات المفصّلة في مقالة إعداد OAuth 2.0 / التطبيقات الأصلية / Android على موقع مساعدة Google Cloud Console الإلكتروني.

  1. في Google Cloud Console، انتقِل إلى لوحة بيانات أداة اختيار المشاريع وحدِّد المشروع الذي تريد استخدامه لإنشاء بيانات اعتماد OAuth.
  2. انتقِل إلى صفحة واجهات برمجة التطبيقات والخدمات، وانقر على بيانات الاعتماد في قائمة التنقّل.
  3. إذا لم تكن قد ضبطت شاشة طلب الموافقة لهذا مشروع على Google Cloud، سيظهر الزر ضبط شاشة طلب الموافقة. في هذه الحالة، يمكنك ضبط شاشة طلب الموافقة باستخدام الإجراء التالي. بخلاف ذلك، انتقِل إلى القسم التالي.

    1. انقر على ضبط شاشة الموافقة. تظهر صفحة شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
    2. استنادًا إلى حالة الاستخدام، اختَر داخلي أو خارجي، ثم انقر على إنشاء. تظهر لوحة شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
    3. أدخِل المعلومات في صفحة معلومات التطبيق وفقًا للتعليمات الظاهرة على الشاشة، ثم انقر على حفظ ومتابعة. يتم عرض لوحة النطاقات.
    4. لست بحاجة إلى إضافة أي نطاقات، لذا انقر على حفظ ومتابعة. تظهر لوحة المستخدمون التجريبيون.
    5. إذا كنت تريد إضافة مستخدمين لاختبار إمكانية الوصول إلى تطبيقك، انقر على إضافة مستخدمين. تظهر لوحة إضافة مستخدمين. يحصل المستخدمون التجريبيون على امتياز منح الأذونات في تطبيقك.
    6. في الحقل الفارغ، أضِف عنوان بريد إلكتروني واحدًا أو أكثر لحساب Google، ثم انقر على إضافة.
    7. انقر على حفظ ومتابعة. تظهر لوحة الملخّص.
    8. راجِع معلومات شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth، ثم انقر على الرجوع إلى لوحة البيانات.

اطّلِع على مقالة إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth على موقع مركز مساعدة Google Cloud Console الإلكتروني للحصول على التفاصيل الكاملة.

تسجيل التطبيق وإنشاء بيانات الاعتماد

لتسجيل التطبيق في OAuth 2.0 وإنشاء بيانات اعتماد OAuth، اتّبِع التعليمات الواردة في إعداد OAuth 2.0. عليك تحديد نوع التطبيق، وهو تطبيق أصلي/تطبيق Android.

أضِف الملف المرجعي SHA-1 الذي حصلت عليه من توقيع التطبيق إلى عميل OAuth الذي أعددته على Google Cloud Console باتّباع التعليمات الواردة في مقالة إعداد OAuth 2.0 / التطبيقات الأصلية على موقع مساعدة Google Cloud Console الإلكتروني.

مع توصيل جهازك الجوّال بجهاز الكمبيوتر، اختَر جهازك من القائمة، ثم انقر على تشغيل المشروع مرة أخرى لتشغيله. للحصول على تعليمات أكثر تفصيلاً، يُرجى الاطّلاع على مقالة تشغيل التطبيقات على جهاز أجهزة على موقع "مطوّرو تطبيقات Android" الإلكتروني.

إذا كان لديك عميل OAuth حالي

إذا كان لديك عميل OAuth تم إثبات ملكيته لتطبيق منشور، يمكنك استخدام عميل OAuth الحالي لاختبار واجهات برمجة تطبيقات Home.

ليس من الضروري تسجيل Google Home Developer Console لاختبار واجهات برمجة التطبيقات Home API واستخدامها. ومع ذلك، سيظلّ عليك الحصول على تسجيل Developer Console تمت الموافقة عليه لنشر تطبيقك، حتى إذا كان لديك ملف تعريف عميل OAuth تم التحقّق منه من عملية دمج أخرى.

تنطبق الاعتبارات التالية:

  • هناك حد أقصى يبلغ 100 مستخدم عند استخدام ملف شخصي حالي لبروتوكول OAuth. للحصول على معلومات عن إضافة مستخدمين تجريبيين، يُرجى الرجوع إلى مقالة إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth. بغض النظر عن عملية إثبات الهوية باستخدام OAuth، هناك حد أقصى لعدد المستخدمين الذين يمكنهم منح أذونات لتطبيقك، وهو 100 مستخدم، وهو الحد الذي تفرضه Home APIs. يتم رفع هذا القيد عند إكمال عملية تسجيل Developer Console.

  • Developer Console تسجيل : يجب إرساله للموافقة عندما تكون مستعدًا لتقييد منح الأذونات لأنواع الأجهزة من خلال OAuth استعدادًا لتعديل تطبيقك باستخدام واجهات برمجة تطبيقات Home.

بالنسبة إلى Google Cloud تطبيقًا لا تزال عملية إثبات الملكية باستخدام OAuth في انتظار المراجعة، لا يمكن للمستخدمين إكمال عملية OAuth إلى أن تكتمل عملية إثبات الملكية. ستتعذّر محاولات منح الأذونات وستظهر رسالة الخطأ التالية:

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