استخدام OAuth

المطوّرون في المنطقة الاقتصادية الأوروبية

تتيح Solar API استخدام بروتوكول OAuth 2.0 للمصادقة. تتيح Google سيناريوهات OAuth 2.0 الشائعة، مثل سيناريوهات خادم الويب.

يوضّح هذا المستند كيفية تمرير رمز OAuth إلى طلب Solar API في بيئة التطوير. للحصول على تعليمات حول استخدام OAuth في بيئة إنتاج، يُرجى الاطّلاع على المصادقة في Google.

قبل البدء

قبل البدء في استخدام Solar API، يجب أن يكون لديك مشروع يتضمّن حساب فوترة وواجهة Solar API مفعّلة. ننصحك بإنشاء عدة حسابات لـ "مالكي المشاريع" و"مشرفي الفوترة"، حتى يتوفّر دائمًا شخص لديه هذه الأدوار لفريقك. لمزيد من المعلومات، يُرجى الاطّلاع على الإعداد في Cloud Console.

لمحة عن بروتوكول OAuth

تتوفّر طرق عديدة لإنشاء رموز الدخول وإدارتها باستخدام OAuth استنادًا إلى بيئة النشر.

على سبيل المثال، يتيح نظام Google OAuth 2.0 التفاعلات بين الخوادم، مثل التفاعلات بين تطبيقك وإحدى خدمات Google. في هذه الحالة، تحتاج إلى حساب خدمة، وهو حساب يخص تطبيقك بدلاً من مستخدم نهائي فردي. يطلب تطبيقك من واجهات برمجة تطبيقات Google تنفيذ إجراءات بالنيابة عن حساب الخدمة، وبالتالي لا يشارك المستخدمون بشكل مباشر. لمزيد من المعلومات عن طرق المصادقة، يُرجى الاطّلاع على مقالة المصادقة في Google.

بدلاً من ذلك، يمكنك استخدام Solar API كجزء من تطبيق متوافق مع Android أو iOS. للحصول على معلومات عامة حول استخدام OAuth مع Solar API، بما في ذلك معلومات حول إدارة رموز الدخول لبيئات النشر المختلفة، يُرجى الاطّلاع على استخدام OAuth 2.0 للوصول إلى Google APIs.

لمحة عن نطاقات OAuth

لاستخدام بروتوكول OAuth مع Solar API، يجب منح رمز OAuth المميز النطاق التالي:

  • https://www.googleapis.com/auth/cloud-platform

مثال: تجربة طلبات البيانات من واجهة REST API في بيئة التطوير المحلية

إذا أردت تجربة Solar API باستخدام رمز OAuth المميز، ولكن لم تكن لديك بيئة إعداد لإنشاء الرموز المميزة، يمكنك استخدام الإجراء الوارد في هذا القسم لإجراء عملية الطلب.

يوضّح هذا المثال كيفية استخدام رمز OAuth المميز الذي توفّره بيانات الاعتماد التلقائية للتطبيق (ADC) لإجراء الطلب. للحصول على معلومات حول استخدام ADC لاستدعاء واجهات Google API باستخدام مكتبات برامج، راجِع مقالة المصادقة باستخدام مكتبات برامج.

المتطلبات الأساسية

قبل أن تتمكّن من تقديم طلب REST باستخدام ADC، استخدِم Google Cloud CLI لتوفير بيانات الاعتماد إلى ADC:

  1. إذا لم يسبق لك ذلك، أنشِئ مشروعًا وفعِّل الفوترة باتّباع الخطوات الواردة في الإعداد في Google Cloud Console.
  2. تثبيت gcloud CLI وإعداده

  3. نفِّذ أمر gcloud التالي على جهازك المحلي لإنشاء ملف بيانات الاعتماد:

    gcloud auth application-default login
  4. تظهر شاشة تسجيل الدخول. بعد تسجيل الدخول، يتم تخزين بيانات الاعتماد في ملف بيانات الاعتماد المحلي الذي تستخدمه أداة ADC.

لمزيد من المعلومات، راجِع قسم بيئة التطوير المحلية في مستندات توفير بيانات الاعتماد لبيانات الاعتماد التلقائية للتطبيق.

إجراء طلب REST

في هذا المثال، يمكنك تمرير عنوانَي طلب:

  • مرِّر رمز OAuth المميز في العنوان Authorization باستخدام الأمر التالي لإنشاء الرمز المميز:

    gcloud auth application-default print-access-token

    يحتوي الرمز المميّز الذي تم إرجاعه على نطاق https://www.googleapis.com/auth/cloud-platform.

  • مرِّر معرّف أو اسم مشروع Google Cloud الذي تم تفعيل الفوترة فيه في العنوان X-Goog-User-Project. لمزيد من المعلومات، يُرجى الاطّلاع على الإعداد في Cloud Console.

يُجري المثال التالي طلبًا إلى Solar API باستخدام رمز OAuth مميز:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
"https://solar.googleapis.com/v1/dataLayers:get?location.latitude=37.4450&location.longitude=-122.1390&radius_meters=100&required_quality=HIGH"

تحديد المشاكل وحلّها

إذا عرض طلبك رسالة خطأ تفيد بأنّ بيانات اعتماد المستخدم النهائي غير متوافقة مع واجهة برمجة التطبيقات هذه، اطّلِع على بيانات اعتماد المستخدم لا تعمل.