استفاده از 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 مراجعه کنید.

درباره 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 API را در محیط توسعه محلی‌تان امتحان کنید

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

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

پیش‌نیازها

قبل‌از اینکه بتوانید بااستفاده از 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، با Roads Selection API تماس بگیرید:

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

عیب‌یابی

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