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 chỉ dành cho những lệnh cung cấp thông tin xác thực phù hợp. Các thông tin đăng nhập này có dạng khoá API – một chuỗi ký tự bao gồm chữ và số liên kết tài khoản thanh toán Google của bạn 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.

Trước khi bắt đầu

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

Tạo khoá API

Lưu ý: Nếu bạn đang sử dụng cả API Địa điểm và API Địa điểm hiện có (Mới) bạn nên tạo một khoá API riêng cho từng phiên bản API. Để tránh bị tính phí do nhầm lẫn, hãy kiểm tra tất cả các khoá API khác để đảm bảo rằng bạn chỉ bật API Địa điểm hoặc API Địa điểm (Mới) trên các khoá đó khi cần.

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 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:

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.

   Truy cập 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 đã được tạo sẽ hiển thị khoá API mới tạo của bạn.
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ế 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"

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

• gcloud alpha services api-keys create

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ẽ giúp tăng cường bảo mật cho ứng dụng của bạn bằng cách bảo vệ tài khoản trước các yêu cầu không hợp lệ. Để biết thêm thông tin, hãy xem phần Các phương pháp hay nhất về bảo mật API.

Khi bạn hạn chế một khoá API trong Cloud Console, chế độ Hạn chế ứng dụng sẽ ghi đè mọi API được bật trong chế độ Hạn chế API. Hãy làm theo các phương pháp hay nhất bằng cách tạo một khoá API riêng cho mỗi ứng dụng và cho mỗi nền tảng có ứng dụng đó.

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

Giao diện dòng lệnh

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

   Truy cập 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 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 sử dụ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 được. Nếu bạn sử dụng mạng dịch địa chỉ (NAT), đị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ế đối với API:
1. Nhấp vào Hạn chế khoá.
2. Chọn API Địa điểm hoặc API Địa điểm (Mới) trong trình đơn thả xuống Select API (Chọn API) nhưng không phải cả hai. Nếu API Địa điểm hoặc API Địa điểm (Mới) không có trong danh sách, bạn cần bật API đó.
   Lưu ý: Nếu đang sử dụng cả API Địa điểm hiện có và API Địa điểm (Mới), bạn nên tạo một khoá API riêng biệt cho mỗi phiên bản API.
4. Để hoàn tất các thay đổi, hãy nhấp vào Lưu.
   

SDK đám mây

Places API (Mới)

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 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.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

Places API

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="places-backend.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:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

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

Bạn phải cung cấp khoá API trong mọi yêu cầu Places API (API Địa điểm). Trong ví dụ sau đây: thay thế YOUR_API_KEY bằng khoá API.

https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&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.

Lưu ý: Khi sử dụng Dịch vụ web, tất cả ký tự đặc biệt bên trong các tham số phải được mã hoá thành URL. URL phải được mã hoá đúng cách để hợp lệ và có giới hạn 2048 ký tự cho tất cả các dịch vụ web. Hãy lưu ý giới hạn này khi tạo URL. Các trình duyệt, proxy và máy chủ khác nhau cũng có thể có giới hạn ký tự URL khác nhau.