Trên hầu hết các trang tài liệu, bạn sẽ thấy một Trình khám phá API thu gọn ở phía bên phải màn hình. Nếu không thấy Trình khám phá API, hãy nhấp vào Dùng thử! để hiển thị phiên bản rút gọn của Trình khám phá API.
Nếu nút Dùng thử! không xuất hiện ở bên phải của trang tài liệu tham khảo, thì có nghĩa là phương thức đó không được APIs Explorer hỗ trợ. Ví dụ: API Explorer không tương thích với những API yêu cầu tài khoản dịch vụ, nên API này không xuất hiện trên các trang tài liệu cho những API đó.
Hiển thị phiên bản mở rộng của Trình khám phá API
Phiên bản mở rộng của Trình khám phá API có chứa cURL, HTTP và có thể là các mẫu mã khác. Để hiển thị phiên bản mở rộng của Trình khám phá API, hãy nhấp vào biểu tượng Toàn màn hình .
Thực thi một phương thức
Trình khám phá API cho phép bạn nhập các tham số bắt buộc, tham số không bắt buộc và (nếu có) nội dung yêu cầu cho các phương thức API. Đối với nhiều phương thức REST (chẳng hạn như phương thức danh sách), bạn chỉ cần điền một hoặc hai trường trước khi có thể thực thi phương thức. Ví dụ: phương thức books.volumes.list của Books API chỉ yêu cầu một tham số truy vấn (q) để liệt kê sách. Cách thử phương thức books.volumes.list:
- Chuyển đến
books.volumes.list. - Nếu Trình khám phá API không xuất hiện, hãy nhấp vào Dùng thử!
- Trong trường
q, hãy nhập Hunger Games (không có dấu ngoặc kép hoặc ký tự đặc biệt). - Di chuyển xuống rồi nhấp vào Thực thi.
- (không bắt buộc) Màn hình đăng nhập bằng Google yêu cầu bạn chọn một Tài khoản Google.
- (không bắt buộc) Hộp thoại uỷ quyền của Google sẽ hỏi bạn xem bạn có muốn "Quản lý sách của bạn" hay không. Nhấp vào Cho phép. Kết quả sẽ xuất hiện bên dưới nút Thực thi.
Nếu Trình khám phá API cho thấy kết quả là 200, thì tức là phương thức đã thành công.
Khắc phục vấn đề với APIs Explorer
Bạn nhận được lỗi 401 hoặc 403
Nếu bạn gặp lỗi 401 hoặc 403 khi thực thi một phương thức bằng API Explorer, thì có thể là do một trong những vấn đề sau:
- Bạn đang sử dụng sai loại uỷ quyền (khoá API thay vì OAuth 2.0). Hãy thử chuyển đổi loại uỷ quyền.
- Bạn đang sử dụng OAuth 2.0, nhưng với phạm vi quá hẹp. Hãy thử sử dụng phạm vi rộng hơn.
Hộp thoại uỷ quyền không xuất hiện
Trình khám phá API sử dụng một cửa sổ bật lên để cấp quyền truy cập vào dữ liệu riêng tư của bạn. Nếu trình duyệt của bạn chặn cửa sổ bật lên, thì cửa sổ bật lên này sẽ không xuất hiện và bạn sẽ không thể cấp quyền truy cập.
Nếu bạn nhấp vào Cho phép trong hộp thoại uỷ quyền nhưng không có gì xảy ra, hãy thử thay đổi chế độ cài đặt cửa sổ bật lên của trình duyệt để bật cửa sổ bật lên.