استفاده از OAuth

«میانای برنامه‌سازی کاربردی مدیریت نقشه» از استفاده از OAuth 2.0 برای اصالت‌سنجی پشتیبانی می‌کند. ‫Google از سناریوهای رایج OAuth 2.0 مثل سناریوهای مربوط به سرور وب پشتیبانی می‌کند.

این سند نحوه انتقال کد OAuth به فراخوانی Map Management API در محیط توسعه شما را شرح می‌دهد. برای دستورالعمل‌های مربوط به استفاده از OAuth در محیط تولید، به اصالت‌سنجی در Google مراجعه کنید.

قبل‌از شروع

قبل‌از شروع استفاده از Map Management API، به پروژه‌ای با حساب صورت‌حساب و Map Management API فعال نیاز دارید. توصیه می‌کنیم چندین مالک پروژه و سرپرست صورت‌حساب ایجاد کنید تا همیشه کسی با این نقش‌ها در تیمتان دردسترس باشد. برای کسب اطلاعات بیشتر، راه‌اندازی در «کنسول Cloud» را ببینید.

درباره OAuth

راه‌های زیادی برای ایجاد و مدیریت کد دسترسی با OAuth براساس محیط استقرار شما وجود دارد.

برای مثال، سیستم Google OAuth 2.0 از تعاملات سروربه‌سرور، مثل تعاملات بین برنامه شما و سرویس Google، پشتیبانی می‌کند. برای این سناریو به حساب خدمات نیاز دارید که حسابی است که به‌جای کاربر نهایی به برنامه شما تعلق دارد. برنامه شما میاناهای برنامه‌سازی کاربردی Google را ازطرف حساب خدمات فراخوانی می‌کند، بنابراین کاربران مستقیماً درگیر نمی‌شوند. برای اطلاعات بیشتر درباره روش‌های اصالت‌سنجی، به اصالت‌سنجی در Google مراجعه کنید.

یا ممکن است از Map Management API به‌عنوان بخشی از برنامه تلفن همراه Android یا iOS استفاده کنید. برای اطلاعات کلی درباره استفاده از OAuth با Map Management API، ازجمله اطلاعات مربوط به مدیریت کدهای دسترسی برای محیط‌های استقرار مختلف، به استفاده از OAuth 2.0 برای دسترسی به Google API مراجعه کنید.

درباره محدوده‌های OAuth

برای استفاده از OAuth با Map Management API، کد OAuth باید به این دامنه اختصاص داده شود:

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

مثال: فراخوانی‌های REST API را در محیط توسعه محلی‌تان امتحان کنید

اگر می‌خواهید «میانای برنامه‌سازی کاربردی مدیریت نقشه» را بااستفاده از کد OAuth امتحان کنید، اما محیطی برای تولید کدها ندارید، می‌توانید از رویه این بخش برای برقراری تماس استفاده کنید.

این مثال نحوه استفاده از کد OAuth ارائه‌شده توسط اطلاعات اعتباری پیش‌فرض برنامه (ADC) را برای برقراری تماس شرح می‌دهد. برای کسب اطلاعات درباره استفاده از ADC برای فراخوانی Google APIs بااستفاده از کتابخانه‌های کارخواه، به اصالت‌سنجی بااستفاده از کتابخانه‌های کارخواه مراجعه کنید.

پیش‌نیازها

پیش‌از اینکه بتوانید بااستفاده از ADC درخواست REST ایجاد کنید، از Google Cloud CLI برای ارائه اطلاعات اعتباری به ADC استفاده کنید:

  1. اگر قبلاً این کار را نکرده‌اید، با دنبال کردن مراحل موجود در راه‌اندازی در کنسول Google Cloud، پروژه‌ای ایجاد کنید و صورت‌حساب را فعال کنید.
  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» را ببینید.

مثال زیر بااستفاده از کد OAuth با Map Management API تماس می‌گیرد:

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/

عیب‌یابی

اگر درخواستتان پیام خطایی درباره پشتیبانی نشدن اعتبارنامه‌های کاربر نهایی توسط این میانای برنامه‌سازی کاربردی برمی‌گرداند، اعتبارنامه‌های کاربر کار نمی‌کند را ببینید.