Sử dụng OAuth

Pollen API hỗ trợ việc sử dụng OAuth 2.0 để xác thực. Google hỗ trợ các trường hợp OAuth 2.0 phổ biến, chẳng hạn như các trường hợp cho máy chủ web.

Tài liệu này mô tả cách chuyển mã thông báo OAuth tới lệnh gọi API Phấn hoa trong phát triển. Để biết hướng dẫn về cách sử dụng OAuth trong môi trường phiên bản chính thức, hãy xem phần Xác thực tại Google.

Trước khi bắt đầu

Trước khi bắt đầu sử dụng API Phấn hoa, bạn cần có dự án có tài khoản thanh toán và APIPhấn hoa được bật. Bạn nên tạo nhiều Chủ dự án và Quản trị viên thanh toán để bạn luôn có người đảm nhận các vai trò này có sẵn cho nhóm của bạn. Để tìm hiểu thêm, hãy xem phần Thiết lập trong Cloud Console.

Giới thiệu về OAuth

Có nhiều cách để tạo và quản lý mã truy cập bằng OAuth dựa vào quá trình triển khai của bạn môi trường.

Ví dụ: hệ thống Google OAuth 2.0 hỗ trợ các hoạt động tương tác giữa các máy chủ, chẳng hạn như giữa ứng dụng của bạn và dịch vụ của Google. Trong trường hợp này, bạn cần có một tài khoản dịch vụ là tài khoản thuộc về ứng dụng của bạn chứ không phải của một người dùng cuối cá nhân. Ứng dụng của bạn thay mặt tài khoản dịch vụ gọi API của Google, vì vậy, người dùng không trực tiếp tham gia. Để biết thêm thông tin về các phương thức xác thực, hãy xem bài viết Xác thực tại Google.

Ngoài ra, bạn có thể sử dụng Pollen API trong một ứng dụng di động Android hoặc iOS. Để biết thông tin chung về cách sử dụng OAuth với Pollen API, bao gồm cả thông tin về cách quản lý mã thông báo truy cập cho nhiều môi trường triển khai, hãy xem phần Sử dụng OAuth 2.0 để truy cập vào API của Google.

Giới thiệu về phạm vi của OAuth

Để sử dụng OAuth với API Pollen, bạn phải chỉ định phạm vi cho mã thông báo OAuth:

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

Ví dụ: Thử các lệnh gọi API REST trong môi trường phát triển cục bộ

Nếu muốn dùng mã thông báo OAuth để thử Pollen API nhưng chưa thiết lập môi trường để tạo mã thông báo, bạn có thể sử dụng quy trình trong phần này để thực hiện lệnh gọi.

Ví dụ này mô tả cách sử dụng mã thông báo OAuth do Thông tin đăng nhập mặc định của ứng dụng (ADC) để thực hiện cuộc gọi. Để biết thông tin về cách sử dụng ADC để gọi API của Google bằng thư viện ứng dụng, hãy xem phần Xác thực bằng thư viện ứng dụng.

Điều kiện tiên quyết

Trước khi bạn có thể tạo một yêu cầu REST bằng ADC, hãy sử dụng Google Cloud CLI để cung cấp thông tin xác thực cho ADC:

  1. Tạo một dự án và bật tính năng thanh toán bằng cách làm theo các bước trong Thiết lập trong Google Cloud Console.
  2. Cài đặt và khởi chạy gcloud CLI.

  3. Chạy lệnh gcloud sau trên máy cục bộ để tạo tệp thông tin xác thực:

    gcloud auth application-default login
  4. Màn hình đăng nhập sẽ hiển thị. Sau khi bạn đăng nhập, thông tin xác thực của bạn sẽ được lưu trữ trong tệp thông tin xác thực cục bộ mà ADC sử dụng.

Để biết thêm thông tin, hãy xem phần Môi trường phát triển cục bộ trong tài liệu Cung cấp thông tin xác thực cho Thông tin xác thực mặc định của ứng dụng.

Tạo yêu cầu REST

Trong ví dụ này, bạn truyền 2 tiêu đề của yêu cầu:

  • Truyền mã thông báo OAuth trong tiêu đề Authorization bằng cách sử dụng lệnh sau để tạo mã thông báo:

    gcloud auth application-default print-access-token

    Mã thông báo được trả về có phạm vi là https://www.googleapis.com/auth/cloud-platform.

  • Chuyển mã hoặc tên của dự án trên Google Cloud đã bật tính năng thanh toán vào Tiêu đề X-Goog-User-Project. Để tìm hiểu thêm, hãy xem Thiết lập trong Cloud Console.

Ví dụ sau đây thực hiện lệnh gọi đến API Phấn hoa bằng mã thông báo OAuth:

curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)"
-H "X-Goog-User-Project: PROJECT_ID" -d '{
  "location": {
    "latitude": 32.62782385865436,
    "longitude": 35.02197334774893
    }
  }'
"https://pollen.googleapis.com/v1/forecast:lookup"

Khắc phục sự cố

Nếu yêu cầu của bạn trả về thông báo lỗi về việc thông tin xác thực của người dùng cuối không được API này hỗ trợ, hãy xem phần Thông tin xác thực của người dùng không hoạt động.