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 của 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 chỉ cho phép các lệnh gọi API chỉ cung cấp thông tin xác thực phù hợp. Các thông tin đăng nhập này sẽ ở dạng khoá API – một chuỗi duy nhất gồm chữ và số, 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.

Trước khi bắt đầu

Trước khi bắt đầu sử dụng API Địa điểm, bạn cần có 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

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 khoá API riêng cho từng phiên bản API. Để tránh bị tính phí ngoài ý muố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 Places API hoặc Places API (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 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) cho thấy 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 cho 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ề Google Cloud SDK, cài đặt SDK đám mây và các lệnh sau:

• gcloud alpha services api-keys create

Hạn chế khoá API

Bạn nên hạn chế các khoá API bằng cách giới hạn phạm vi sử dụng của các khoá đó chỉ những API cần thiết cho ứng dụng của bạn. Việc hạn chế các 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 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.

Khi hạn chế một khoá API trong Cloud Console, Hạn chế ứng dụng sẽ ghi đè mọi API được bật trong phần 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 từng ứng dụng và cho mỗi nền tảng nơi ứng dụng đó hoạt động.

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ế đối với ứng dụng:
1. Để chấp nhận 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, công việc cron, v.v.) trong danh sách Hạn chế ứng dụng. Hãy 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. Nếu bạn sử dụng tính năng dịch địa chỉ mạng (NAT), thì thông tin 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 API Địa điểm hoặc API Địa điểm (Mới) trong trình đơn thả xuống Chọn API, nhưng không được chọn 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 phải enable những API đó.
   Lưu ý: Nếu đ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 khoá API riêng cho từng phiên bản API.
4. Để hoàn tất nội dung thay đổi, hãy nhấp vào Save (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 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.googleapis.com"
    --allowed-ips="IP_ADDRESS"

Đọc thêm về Google Cloud SDK, cài đặt SDK đám mây 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 đị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"

Đọc thêm về Google Cloud SDK, cài đặt SDK đám mây 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 thêm khoá API vào 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://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=YOUR_API_KEY

Bạn phải nhập 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 thông số phải được mã hoá theo URL. URL phải được mã hoá đúng cách thì mới hợp lệ và được giới hạn trong 2048 ký tự cho tất cả các dịch vụ web. Hãy lưu ý đến 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.