استخدام OAuth

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

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

قبل البدء

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

لمحة عن OAuth

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

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

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

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

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

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

إذا أردت تجربة Map Management 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.

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

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
https://mapmanagement.googleapis.com/v2beta/projects/PROJECT_NUMBER_OR_ID/mapConfigs/

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

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