Sử dụng Khoá API với API Xác thực địa chỉ

Các sản phẩm trên Nền tảng Google Maps được bảo vệ khỏi việc sử dụng trái phép bằng cách chỉ cho phép các lệnh gọi API cung cấp thông tin xác thực phù hợp. Các thông tin xác thực này có dạng khoá API – một chuỗi chữ và số duy nhất liên kết tài khoản thanh toán trên Google với dự án của bạn, cũng như 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 giúp 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 liên kết 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 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 (Đã tạo khoá API) 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 dùng khoá này trong quá trình phát hành chính thức.)

SDK đám mây

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

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

Hạn chế khoá API

Bạn nên hạn chế khoá API bằng cách chỉ sử dụng các khoá API cần thiết cho ứng dụng. Việc hạn chế khoá API giúp tăng cường tính 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 phù hợp. Để biết thêm thông tin, hãy xem bài viết 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 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. Chọn khoá API mà bạn muốn đặt hạn chế. Trang thuộc tính khoá API sẽ xuất hiện.
  3. Trong mục Khóa hạn chế, hãy đặt các hạn chế sau:
    • Hạn chế áp 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, cron job, v.v.) trong danh sách Các hạn chế đối với ứ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à các máy chủ Nền tảng Google Maps quan sát được. Nếu bạn sử dụng dịch địa chỉ mạng (NAT), địa chỉ này thường tương ứng với địa chỉ IP công khai của máy của bạn.
    • Các hạn chế đối với API:
      1. Nhấp vào Restrict key (Hạn chế khoá).
      2. Chọn Address Validation API (API xác thực địa chỉ) trong trình đơn thả xuống Select APIs (Chọn API). Nếu API xác thực địa chỉ không có trong danh sách, bạn cần phải 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 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="addressvalidation.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

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

Bạn phải thêm một khoá API vào mỗi yêu cầu API Xác thực địa chỉ. Trong ví dụ sau, hãy thay thế YOUR_API_KEY bằng khoá API.

https://addressvalidation.googleapis.com/v1:validateAddress?key=YOUR_API_KEY

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