Tìm và chọn API của Google

1. Trước khi bắt đầu

Lớp học lập trình này hướng dẫn bạn cách tìm kiếm và chọn API của Google, cũng như xem các chỉ số API.

Điều kiện tiên quyết

  • Có thể điều hướng trong Google Cloud Console.

Kiến thức bạn sẽ học được

Bạn cần có

2. Truy cập vào các API từ Cloud Console

  1. Trong Cloud Console, hãy chọn 5854836f11d5d97b.png Trình đơn điều hướng > API và dịch vụ > API và dịch vụ đã bật.

Trình đơn điều hướng trong Cloud Console

  1. Trong trang tổng quan API và dịch vụ, hãy nhấp vào + BẬT API VÀ DỊCH VỤ để xem các API có sẵn.

Trang tổng quan về API và dịch vụ cho thấy lựa chọn BẬT API VÀ DỊCH VỤ.

Trên trang API và Dịch vụ, bạn có thể tìm kiếm API theo nhiều cách. Nếu biết tên của API, bạn có thể nhập tên đó vào trường Tìm kiếm API và dịch vụ ở đầu trang. Bạn cũng có thể lọc API theo danh mục bằng các bộ lọc ở bên cạnh trang.

Danh sách các API xuất hiện khi bạn tìm kiếm trong trường Tìm kiếm API và dịch vụ.

  1. Trong trình đơn DANH MỤC, hãy chọn Học máy để chỉ xem các API Học máy.

Các API được lọc theo DANH MỤC để chỉ hiển thị các API Học máy.

  1. Trong phần Machine Learning API, hãy chọn Cloud Natural Language API để xem thông tin chi tiết về API này.
  2. Nhấp vào BẬT để bật API này trong dự án thích hợp.

Ngăn Cloud Natural Language API cho thấy các nút BẬT và DÙNG THỬ API NÀY.

Khi bạn bật API, trang Tổng quan về API sẽ xuất hiện. Bạn có thể xem các chỉ số về mức sử dụng API này. API này có rất ít thông tin vì bạn mới bật API gần đây.

Trang Tổng quan của API đã chọn cho thấy các chỉ số của API.

Trong một lớp học lập trình sau này, bạn sẽ tìm hiểu thêm về cách tạo thông tin xác thực. Tuy nhiên, nếu muốn tìm hiểu ngay bây giờ, hãy nhấp vào TẠO THÔNG TIN XÁC THỰC rồi trả lời các câu hỏi xuất hiện.

  1. Nhấp vào QUẢN LÝ để quay lại phần tổng quan ở bước trước.

Trang tổng quan về Cloud Natural Language API.

  1. Để dùng thử API (ngay cả trước khi bạn bật API), hãy nhấp vào DÙNG THỬ API NÀY.

Thao tác này thường đưa bạn đến một trang trong tài liệu về API. Tuy nhiên, đối với một số API, bạn không thể dùng thử ngay vì API đó có nhiều phương thức khác nhau. Đó là trường hợp của Cloud Natural Language API.

Trang tham khảo của Cloud Natural Language API.

  1. Chọn phương thức analyzeEntitites.

Bạn sẽ thấy một trang web có thông tin chi tiết về các phương thức của API và ngăn Dùng thử API này.

Trang cho phương thức analyzeEntitites cho thấy thông tin chi tiết về phương thức và ngăn Dùng thử API này.

  1. Để thử một truy vấn mẫu, hãy thêm một đối tượng document vào trường Nội dung yêu cầu bằng các tham số sau. Nhấp vào biểu tượng + để mở rộng các lựa chọn về trường.
  2. Trong trường content:, hãy nhập văn bản cần phân tích.

Ví dụ này sử dụng Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. Trong trường type:, hãy chọn PLAIN_TEXT.

Nội dung yêu cầu sẽ có dạng như sau:

Ngăn nội dung yêu cầu cho thấy các tham số nội dung yêu cầu.

Để biết thêm thông tin về từng tham số, hãy tham khảo tài liệu.

  1. Bỏ chọn hộp kiểm Google OAuth 2.0 rồi nhấp vào Thực thi để nhận được phản hồi kèm theo thông tin chi tiết về các thực thể.

Phản hồi 200 kèm theo thông tin chi tiết về các thực thể.

  1. Xoá hộp đánh dấu Khoá API rồi nhấp lại vào Thực thi.

Khi thực thi truy vấn lần này, bạn sẽ gặp phải một lỗi như thế này vì API yêu cầu thông tin đăng nhập để chạy.

Phản hồi 403 cho yêu cầu thiếu thông tin đăng nhập.

  1. Chọn hộp đánh dấu Google OAuth 2.0 rồi nhấp lại vào Execute (Thực thi).

OAuth 2.0 cung cấp các quyền API trên tài khoản của bạn và cho bạn thấy một cảnh báo.

Cảnh báo OAuth 2.0 cho biết Google APIs Explorer muốn truy cập vào Tài khoản Google của bạn.

Nếu cho phép truy cập, bạn sẽ nhận được phản hồi tương tự như khi dùng khoá API. Nếu sử dụng API trong một ứng dụng và cần cấp quyền truy cập cho những cá nhân có kiến thức về thông tin đăng nhập của họ, bạn cần sử dụng OAuth 2.0. Nếu chỉ cần ứng dụng truy cập vào API cho người dùng, bạn có thể sử dụng khoá API.

3. Xem các chỉ số API bằng Trình khám phá chỉ số

Bạn có thể xem nhật ký các lệnh gọi cho bất kỳ API nào trên trang Tổng quan về API, như minh hoạ trong bước 6 của phần Truy cập vào API từ Cloud Console. Tuy nhiên, để xem thêm chỉ số về tất cả hoạt động sử dụng API, hãy sử dụng Trình khám phá chỉ số.

  1. Trong mục Operations (Thao tác) của f6b6844bf5688982.png Trình đơn điều hướng, hãy nhấp vào Monitoring > Metrics explorer (Giám sát > Trình khám phá chỉ số).

Mục Operations (Hoạt động) trong trình đơn điều hướng, trong đó các lựa chọn Monitoring (Giám sát) và Metrics explorer (Trình khám phá chỉ số) được chọn.

  1. Trong trình đơn Resource type (Kiểu tài nguyên), hãy chọn Consumed API (API đã sử dụng) làm kiểu chỉ số. (Nếu bạn không thấy mục đó, hãy xoá hộp đánh dấu Chỉ hiện các mục đang hoạt động.)

ca850c4295ef4ec9.png

  1. Trong trình đơn Chỉ số, hãy chọn một trong các chỉ số riêng lẻ cho API, chẳng hạn như Số yêu cầu, để xem có bao nhiêu API được gọi trong khoảng thời gian nhất định.

Trình khám phá chỉ số cho thấy các chỉ số API đã sử dụng cho Số yêu cầu.

  1. Để tuỳ chỉnh thêm kết quả, hãy đặt một hàm tổng hợp và điều chỉnh khoảng thời gian. Trình khám phá chỉ số cho thấy các chỉ số API đã sử dụng cho Số yêu cầu với một bộ tổng hợp và khoảng thời gian được chỉ định.

4. Sử dụng OAuth 2.0 Playground để dùng thử các API

Bạn cũng có thể sử dụng OAuth 2.0 Playground để dùng thử các API của Google. Với OAuth 2.0 Playground, bạn có thể chọn một API, uỷ quyền API đó, rồi gửi yêu cầu và xem các phản hồi trong cửa sổ bảng điều khiển của OAuth 2.0 Playground.

  1. Mở OAuth 2.0 Playground.

OAuth 2.0 Playground cho thấy danh sách các API mà bạn có thể dùng thử.

  1. Nhấp vào Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Authorize APIs (Cloud Natural Language API > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Uỷ quyền cho API).

OAuth 2.0 Playground cho thấy các API Xử lý ngôn ngữ tự nhiên trên đám mây được chọn.

  1. Nếu cần, hãy đăng nhập vào Tài khoản Google của bạn rồi nhấp vào Cho phép để nhận mã uỷ quyền.
  2. Nhấp vào Đổi mã uỷ quyền lấy mã thông báo.

Ngăn Đổi mã uỷ quyền lấy mã thông báo, nơi bạn có thể nhấp vào Đổi mã uỷ quyền lấy mã thông báo.

Giờ đây, bạn có thể đưa ra yêu cầu đối với API.

  1. Nhấp vào Liệt kê các thao tác có thể thực hiện để xem xét tất cả các lệnh gọi API có thể thực hiện.

Trước đây, bạn đã mở trang thông tin cho tài liệu Natural Language API analyzeEntities, vì vậy, bạn có thể thấy rằng URL cho yêu cầu HTTP là:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

Đây là một yêu cầu POST.

Định cấu hình yêu cầu cho ngăn API. Tại đây, bạn có thể chọn phương thức HTTP, đăng ký URI yêu cầu, nhập phần nội dung yêu cầu và gửi yêu cầu.

  1. Nhập thông tin URI yêu cầu và thêm một phần nội dung yêu cầu.

Bạn có thể sử dụng cùng một nội dung mà bạn đã dùng trong Trình khám phá API.

Ngăn nội dung yêu cầu.

  1. Nhấp vào Đóng > Gửi yêu cầu.

Bạn sẽ nhận được kết quả tương tự như hình ảnh này:

Ngăn Yêu cầu/Phản hồi OAuth 2.0 sau khi đăng yêu cầu.

Bạn có thể tuỳ ý thử nghiệm các API khác trong OAuth 2.0 Playground.

5. Dọn dẹp

Bạn không nên sử dụng khoá API không bị hạn chế cho các dự án. Nếu có quyền truy cập vào khoá truy cập, người đó có thể sử dụng khoá truy cập mà không cần xác thực thêm.

Cách xoá khoá API này:

  1. Nhấp vào f6b6844bf5688982.png Trình đơn điều hướng > API và Dịch vụ > Thông tin xác thực.
  2. Trong mục API Keys (Khoá API), hãy chọn khoá cần xoá rồi nhấp vào biểu tượng 247adf2e1d1eae4b.png.
  3. Tương tự, thay vì lo lắng về việc Khoá riêng tư của tài khoản dịch vụ không được bảo vệ, trong mục Tài khoản dịch vụ, hãy chọn tài khoản dịch vụ cần xoá rồi nhấp vào 247adf2e1d1eae4b.png.

6. Xin chúc mừng

Xin chúc mừng! Bạn đã tìm hiểu cách tìm kiếm và chọn các API của Google, cũng như xem chỉ số của các API đó.