استفاده از OAuth

Map Management API از 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 APIs مراجعه کنید.

درباره دامنه‌های OAuth

برای استفاده از OAuth با Map Management API، کد OAuth باید دارای محدوده https://www.googleapis.com/auth/cloud-platform باشد.

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

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

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

پیش‌نیازها

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

  1. اگر قبلاً این کار را نکرده‌اید، با دنبال کردن مراحل راه‌اندازی در «کنسول 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/

عیب‌یابی

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