Sử dụng khoá API với API Chỉ dẫn

Các sản phẩm của Google Maps Platform được bảo mật khỏi việc 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 lệnh gọi cung cấp thông tin xác thực phù hợp. Thông tin đăng nhập 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 của bạn trê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 trình bày cách tạo, hạn chế và sử dụng khoá API cho Nền tảng Google Maps.

Trước khi bắt đầu

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

Tạo khoá API

Khoá API là một 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ủa mình.

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 đăng nhập.

    Chuyển đến trang Thông tin đăng nhập

  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 sẽ hiển thị khoá API mà bạn vừa tạo.
  3. Nhấp vào Đóng.
    Khoá API mới sẽ xuất hiện trên trang Thông tin xác thực trong phần Khoá API.
    (Hãy nhớ hạn chế API trước khi sử dụng khoá này trong quá trình phát hành công khai.)

SDK đám mây

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

Đọc thêm về Google Cloud SDK, quy trình 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 chỉ cho những API cần thiết cho ứng dụng của bạn. Việc hạn chế khoá API sẽ 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 chính đáng. Bạn chịu trách nhiệm về tài chính đối với các khoản phí do việc sử dụng sai khoá API không bị hạn chế. Để biết thêm thông tin, hãy xem các phương pháp bảo mật hay nhất cho API.

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

Giao diện dòng lệnh

  1. Chuyển đến trang Nền tảng Google Maps > Thông tin đăng nhập.

    Chuyển đến trang Thông tin đăng nhập

  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ế cho 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 định kỳ, 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à các máy chủ của Nền tảng Google Maps quan sát được. Nếu bạn sử dụng dịch đị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 tắc hạn chế đối với API:
      1. Nhấp vào Restrict key (Hạn chế cho khoá).
      2. Chọn Directions API trong trình đơn thả xuống Chọn API. Nếu Directions API 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 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 services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Đặt các hạn chế mới cho khoá hiện có.

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=directions-backend.googleapis.com
    --allowed-ips="IP_ADDRESS"

Đọc thêm về Google Cloud SDK, quy trình 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 khoá API cho mọi yêu cầu Directions API. Trong ví dụ sau, hãy thay thế YOUR_API_KEY bằng khoá API của bạn.

https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY

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