Sử dụng khóa API

Chọn nền tảng: Android iOS JavaScript

Chủ đề này mô tả cách tạo khoá API cho SDK Maps dành cho Android, thêm khoá đó vào ứng dụng của bạn và bảo mật ứng dụng bằng cách hạn chế khoá. Bạn phải thêm khoá API vào mọi ứng dụng sử dụng SDK.

Trước khi bắt đầu

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

Tạo khoá API

Khoá API là giá trị nhận dạng riêng biệt giúp xác thực các yêu cầu liên quan đến dự án của bạn vì 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:

Bảng điều khiển

  1. Truy cập vào trang gt;Thông tin xác thực của Google Maps.

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

  2. Trên trang Thông tin đăng nhập, 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 bạn 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 bản phát hành 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 đám mây và các lệnh sau:

Hạn chế các khoá API

Bạn rất nên hạn chế 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 sẽ tăng cường 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 được đảm bảo. Để 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ế khoá API, bạn phải cung cấp tệp tham chiếu chứng chỉ SHA-1 của khoá ký dùng để ký ứng dụng. Có hai loại chứng chỉ:

  • Chứng chỉ gỡ lỗi: Chỉ sử dụng loại chứng chỉ này với các ứng dụng bạn đang kiểm thử và các mã khác không phải là mã phát hành chính thức. Đừng tìm cách phát hành ứng dụng được ký bằng chứng chỉ gỡ lỗi. Các công cụ SDK Android sẽ tự động tạo chứng chỉ này khi bạn chạy bản dựng gỡ lỗi.
  • Chứng chỉ phát hành: Sử dụng chứng chỉ này khi bạn đã sẵn sàng phát hành ứng dụng lên cửa hàng ứng dụng. Các công cụ SDK Android sẽ tạo chứng chỉ này khi bạn chạy bản phát hành.

Để biết thêm thông tin về chứng chỉ kỹ thuật số, hãy xem hướng dẫn về Ký ứng dụng.

Để biết thông tin về cách lấy vân tay số cho chứng chỉ, hãy xem phần Xác thực ứng dụng. Nếu đang dùng tính năng Ký ứng dụng của Play, thì bạn phải truy cập vào trang ký ứng dụng trên Play Console để lấy vân tay số của chứng chỉ.

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

Bảng điều khiển

  1. Truy cập vào trang gt;Thông tin xác thực của Google Maps.

    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 Key restrictions (Hạn chế cho khoá), hãy đặt các quy định hạn chế sau:
    • Hạn chế ứng dụng:
      1. Chọn Ứng dụng Android.
      2. Nhấp vào + Thêm tên gói và vân tay.
      3. Nhập tên gói và vân tay số của chứng chỉ SHA-1. Ví dụ:
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Các hạn chế về API:
      1. Nhấp vào Hạn chế khoá.
      2. Chọn Maps SDK dành cho Android từ trình đơn thả xuống Chọn API. Nếu SDK Maps dành cho Android không có trong danh sách, bạn cần bật.
  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 quy định hạn chế hiện có đối với khóa 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="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

Bước tiếp theo

Bây giờ, bạn đã có khoá API, hãy tạo và định cấu hình một dự án như mô tả trong bài viết Thiết lập dự án Android Studio.