Sử dụng Khoá API với API Địa điểm

Chọn nền tảng: Android iOS JavaScript Dịch vụ web

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 đối với những sản phẩm cung cấp thông tin xác thực phù hợp. Những thông tin đăng nhập này có dạng khóa API – một chuỗi chữ và số duy nhất liên kết tài khoản thanh toán Google với dự án của bạn và với API hoặc SDK cụ thể.

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

Trước khi bắt đầu

Trước khi bắt đầu sử dụng API Địa điểm, bạn cần một dự án có tài khoản thanh toán và đã bật API Địa điểm. Để tìm hiểu thêm, hãy xem bài viết Thiết lập trong Cloud Console.

Tạo khoá API

Khoá API là giá trị nhận dạng riêng biệ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 liên kết ít nhất một khoá API với dự án của mình.

Cách tạo khoá API:

Bảng điều khiển

  1. Chuyển đến trang Google Maps Platform > 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 đã tạo khoá API hiển thị khoá API mới tạo.
  3. Nhấp vào Đóng.
    Khóa API mới được liệt kê trên trang Thông tin xác thực trong Khóa API.
    (Hãy nhớ hạn chế khoá API trước khi sử dụng trong phiên bản chính thức.)

SDK đám mây

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

Hãy đọc thêm về Google Cloud SDK , Cài đặt SDK Cloud và các lệnh sau:

Hạn chế đối với khoá API

Bạn nên hạn chế các khoá API bằng cách chỉ sử dụng các API đó cho những API cần thiết cho ứng dụng. Việc hạn chế khoá API giúp tăng cường bảo mật cho ứng dụng bằng cách bảo vệ ứng dụng khỏi các yêu cầu không chính đáng. Để 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:

Bảng điều khiển

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

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

  2. Chọn khoá API mà bạn muốn áp dụng một quy định hạn chế. Trang thuộc tính khoá API sẽ xuất hiện.
  3. Trong mục Key restrictions (Hạn chế cho khoá), hãy đặt các hạn chế sau:
    • Hạn chế ứng dụng:
      1. Để chấp nhận các yêu cầu từ danh sách địa chỉ IP của máy chủ web mà bạn cung cấp, hãy chọn Địa chỉ IP (máy chủ web, lệnh cron, v.v.) trong danh sách Hạn chế ứng dụng. Hãy chỉ định một địa chỉ IPv4 hoặc IPv6 hoặc một mạng con sử dụng ký hiệu Định tuyến liên miền không lớp (CIDR) (ví dụ: 192.168.0.0/22). Vì yêu cầu dịch vụ web kiểm tra và so sánh địa chỉ IP bên ngoài với quy định hạn chế đối với khoá API, hãy sử dụng địa chỉ IP công khai của máy chủ.
    • Các hạn chế đối với API:
      1. Nhấp vào Hạn chế khoá.
      2. Chọn Places API (API địa điểm) từ trình đơn thả xuống Select APIs (Chọn API). Nếu API Địa điểm không có trong danh sách, bạn cần bật API này.
  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 khóa hiện có.

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

Xóa các hạn chế hiện có đối với khóa hiện tại.

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

Đặt các quy định 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="places-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

Hãy đọc thêm về Google Cloud SDK , Cài đặt SDK Cloud và các lệnh sau:

Thêm khoá API vào yêu cầu của bạn

Bạn phải bao gồm khóa API với mọi yêu cầu API địa điểm. Trong ví dụ sau, hãy thay thế YOUR_API_KEY bằng khoá API.

https://maps.googleapis.com/maps/api/place/nearbysearch/json?location=-33.8670522,151.1957362&radius=500&types=restaurant&name=harbour&key=YOUR_API_KEY

HTTPS là yêu cầu bắt buộc đối với các yêu cầu dùng khoá API.