Menguji dengan berbagai jenis dan cakupan kredensial

Bagian kredensial API Explorer memungkinkan Anda menguji dengan kredensial dan cakupan yang berbeda. Fitur ini berguna untuk memastikan bahwa Anda menggunakan kredensial dan cakupan minimal yang diperlukan untuk memanggil endpoint API.

Menguji dengan kredensial yang berbeda

Secara default, jenis kredensial OAuth 2 dan Kunci API dicentang. Jika Anda ingin menguji hanya dengan satu kredensial, centang jenis kredensial untuk digunakan (dan hapus centang jenis kredensial lainnya). Berikut adalah aturan umum untuk memilih kredensial yang akan diuji:

  • Jika menggunakan metode untuk mengakses data publik, seperti data Google Maps, Anda dapat menggunakan kunci API sebagai kredensial. Centang Kunci API dan hapus centang Google OAuth 2.0.

  • Jika menggunakan metode untuk mengakses data pribadi, seperti data Google Drive pengguna, Anda harus menggunakan kredensial OAuth 2. Hapus centang Kunci API dan centang Google OAuth 2.0.

Jika Anda menerima hasil 200, kredensial sudah memadai untuk mengakses data. Jika menerima hasil 401, Anda harus menggunakan kredensial OAuth 2 untuk mengakses data.

Menguji dengan cakupan yang berbeda

Cakupan adalah string, seperti https://www.googleapis.com/auth/drive.metadata.readonly, yang menentukan tingkat akses ke resource yang diperlukan oleh aplikasi Anda, seperti tingkat akses ke data yang dimiliki oleh pengguna. Idealnya, Anda ingin aplikasi Anda menggunakan cakupan dengan tingkat akses tersempit ke data pengguna. Metode yang berbeda mungkin memerlukan cakupan yang berbeda. Misalnya, metode dalam API mungkin memerlukan setidaknya cakupan hanya-baca, sedangkan metode lain mungkin memerlukan cakupan baca-tulis.

Secara default, semua cakupan Google OAuth 2.0 untuk API diaktifkan di Penjelajah API. Untuk menguji dengan cakupan tertentu:

  1. Di bagian Kredensial Google OAuth 2.0, klik tampilkan cakupan.
  2. Periksa cakupan yang akan digunakan saat memanggil metode.
  3. Klik Jalankan untuk menjalankan API hanya menggunakan cakupan yang dipilih. APIs Explorer menampilkan layar otorisasi yang meminta Anda memberikan akses untuk menggunakan cakupan.
  4. Klik Izinkan. Hasilnya akan muncul di bawah tombol Execute.

Jika APIs Explorer menampilkan hasil 200 pada "application/json", cakupan cukup untuk memanggil metode. Jika APIs Explorer menampilkan hasil 403, cakupan yang Anda pilih tidak cukup untuk memanggil metode. Coba cakupan yang lebih luas.

Untuk informasi tambahan tentang pemilihan cakupan, lihat bagian autentikasi dan otorisasi untuk dokumentasi Google API spesifik Anda.

Cabut akses terotorisasi untuk menguji dengan cakupan baru

Setelah menggunakan layar otorisasi Google untuk menyetujui otorisasi, Penjelajah API akan tetap diberi otorisasi untuk membuat permintaan yang diautentikasi selama kredensial tersebut tidak habis masa berlakunya. Menghapus centang cakupan tidak mereset kredensial dan cakupan yang sebelumnya disetujui. Jika ingin menguji dengan konfigurasi cakupan baru, Anda harus mencabut kredensial yang sebelumnya disetujui.

Untuk mencabut kredensial yang digunakan oleh APIs Explorer:

  1. Buka Aplikasi yang dapat mengakses akun Anda.
  2. Di bagian Aplikasi pihak ketiga dengan akses akun, klik Penjelajah Google API.
  3. Klik Hapus Akses.
  4. (opsional) Muat ulang halaman dokumentasi untuk mereset APIs Explorer.