Sử dụng khoá API với API phấn hoa

Các sản phẩm trên Nền tảng Google Maps được bảo vệ khỏi hành vi sử dụng trái phép bằng cách hạn chế các lệnh gọi API chỉ dành cho những lệnh cung cấp thông tin xác thực phù hợp. Thông tin xác thực này ở dạng khoá API – một chuỗi ký tự và số duy nhất liên kết tài khoản thanh toán của bạn trên Google với dự án và với API hoặc SDK cụ thể.

Hướng dẫn này trình bày cách tạo, hạn chế và sử dụng khoá API cho Nền tảng Google Maps.

Tạo khoá API

Khoá API là giá trị nhận dạng duy nhất xác thực các yêu cầu liên kết với dự án của bạn cho mục đích sử dụng và thanh toán. Bạn phải có ít nhất một khoá API được liên kết với dự án.

Cách tạo khoá API:

Giao diện dòng lệnh

  1. Chuyển đến trang Nền tảng Google Maps > Thông tin xác thực.

    Chuyển đến trang Thông tin xác thực

  2. Trên trang Thông tin xác thực, hãy nhấp vào Tạo thông tin xác thực > Khoá API.
    Hộp thoại API key created (Khoá API đã tạo) hiển thị khoá API mới tạo.
  3. Nhấp vào Đóng.
    Khoá API mới được liệt kê trên trang Thông tin xác thực trong phần Khoá API.
    (Hãy nhớ hạn chế khoá API trước khi sử dụng khoá đó trong môi trường sản xuất.)

SDK đám mây

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Đọc thêm về Google Cloud SDK , cách cài đặt Cloud SDK và các lệnh sau:

Hạn chế khoá API

Bạn nên hạn chế khoá API bằng cách giới hạn việc sử dụng khoá API ở những API cần thiết cho ứng dụng của mình. Việc hạn chế khoá API sẽ tăng cường bảo mật cho ứng dụng của bạn bằng cách bảo vệ ứng dụng khỏi các yêu cầu không hợp lệ. Để biết thêm thông tin, hãy xem Các phương pháp hay nhất về bảo mật API.

Cách hạn chế khoá API:

Giao diện dòng lệnh

  1. Truy cập vào trang Nền tảng Google Maps > Thông tin đăng nhập.

    Chuyển đến trang Thông tin xác thực

  2. Chọn khoá API mà bạn muốn đặt quy tắc hạn chế. Trang thuộc tính khoá API sẽ xuất hiện.
  3. Trong mục Key Restrictions (Hạn chế về khoá), hãy đặt các hạn chế sau:
    • Hạn chế về ứng dụng:
      1. Để chấp nhận các yêu cầu từ danh sách địa chỉ IP máy chủ web mà bạn cung cấp, hãy chọn Địa chỉ IP (máy chủ web, công việc cron, v.v.) trong danh sách Hạn chế về ứng dụng. Chỉ định một hoặc nhiều địa chỉ IPv4 hoặc IPv6 hoặc mạng con bằng ký hiệu CIDR. Địa chỉ IP phải khớp với địa chỉ nguồn mà máy chủ Nền tảng Google Maps quan sát thấy. Nếu bạn sử dụng chuyển đổi địa chỉ mạng (NAT), thì địa chỉ này thường tương ứng với địa chỉ IP công khai của máy.
    • Các quy định hạn chế về API:
      1. Nhấp vào Hạn chế khoá.
      2. Chọn Pollen API trong trình đơn thả xuống Select APIs (Chọn API). Nếu Pollen API không có trong danh sách, bạn cần bật API đó.
  4. Để hoàn tất các thay đổi, hãy nhấp vào Lưu.

SDK đám mây

Liệt kê các khoá hiện có. 

gcloud services api-keys list --project="PROJECT"

Xoá các quy định hạn chế hiện có đối với khoá hiện có. 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Đặt các quy tắc hạn chế mới đối với khoá hiện có. 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="pollen.googleapis.com"
    --allowed-ips="IP_ADDRESS"

Đọc thêm về Google Cloud SDK, cách cài đặt Cloud SDK và các lệnh sau:

Thêm khoá API vào yêu cầu

Bạn phải cung cấp một khoá API với mọi yêu cầu API Phấn hoa. Trong ví dụ sau, hãy thay thế YOUR_API_KEY bằng khoá API của bạn.

https://pollen.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY

Bạn phải sử dụng giao thức HTTPS cho các yêu cầu sử dụng khoá API.