استخدام OAuth

تستخدم Roads Selection API واجهة برمجة التطبيقات Roads Selection API كمكوّن أساسي يوفّر بيانات الطرق لـ BigQuery وPub/Sub.

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

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

قبل البدء

قبل البدء في استخدام Roads Selection API، يجب أن يكون لديك مشروع يتضمّن حساب فوترة وأن تكون Roads Selection API مفعَّلة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة الإعداد في Cloud Console.

لمحة عن OAuth

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

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

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

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

لاستخدام OAuth مع Roads Selection API، يجب أن يتضمّن رمز OAuth المميّز النطاق https://www.googleapis.com/auth/cloud-platform.

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

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

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

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

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

  1. إذا لم يسبق لك إنشاء مشروع وتفعيل الفوترة، يمكنك إجراء ذلك باتّباع الخطوات الواردة في مقالة الإعداد في 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.

أرسِل طلبًا إلى Roads Selection API باستخدام رمز OAuth المميّز:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
https://roads.googleapis.com/selection/v1/projects/PROJECT_NUMBER/selectedRoutes/SELECTED_ROUTE_ID

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

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