Sử dụng khóa API

Tạo khoá API

Khoá API là một 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:

Giao diện dòng lệnh

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

    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 Close (Đó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 sử dụng khoá đó cho phiên bản phát hành công khai.)

SDK đám mây

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

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

Hạn chế khoá API

Bạn nên hạn chế các khoá API của mình bằng cách chỉ sử dụng các khoá đó ở những API chỉ 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 có lý do chính đáng. Để 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.

Khi hạn chế khoá API, bạn phải cung cấp dấu vân tay 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à mã không phát hành công khai khác. Đừng tìm cách phát hành một ứng dụng đã được ký bằng chứng chỉ gỡ lỗi. Bộ công cụ SDK Android sẽ tự động tạo chứng chỉ này khi bạn chạy một bản 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. Bộ công cụ SDK Android sẽ tạo chứng chỉ này khi bạn chạy một bản phát hành.

Để biết thêm thông tin về tính năng ký ứng dụng Android và chứng chỉ, hãy xem hướng dẫn Ký ứng dụng.

Để biết hướng dẫn về cách tìm dấu vân tay chứng chỉ ký, hãy xem các tài liệu tham khảo bên dưới:

  • Nếu bạn đang sử dụng Tính năng ký ứng dụng của Play, hãy xem bài viết Làm việc với nhà cung cấp API.
  • Nếu bạn quản lý khoá ký của riêng mình, hãy xem phần Tự ký ứng dụng hoặc tham khảo hướng dẫn dành cho môi trường tạo bản dựng.

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

Giao diện dòng lệnh

  1. Truy cập vào trang 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:
    • Quy định hạn chế đối với ứ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 số.
      3. Nhập tên gói và dấu vân tay 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 quy định hạn chế đối với API:
      1. Nhấp vào Hạn chế khoá.
      2. Chọn Navigation SDK (SDK điều hướng) trong trình đơn thả xuống Select APIs (Chọn API). Nếu không có trong danh sách SDK điều hướng, bạn cần enable SDK đó.
  4. Để hoàn tất nội dung 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 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="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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