API 3.x akan dinonaktifkan pada Agustus 2023
Sebelumnya, kami telah menyampaikan bahwa perubahan ini akan terjadi pada rilis Juli 2023. Berdasarkan masukan pelanggan, kami telah memindahkan batas waktu ini kembali ke Agustus 2023 untuk membantu memperlancar transisi ini. Tutup dialog ini untuk mengetahui detail lebih lanjut.
Setelah rilis GA API 4.0 di Looker 22.4, kami mengumumkan penghentian penggunaan API 3.1, selain API 3.0 yang sudah tidak digunakan lagi.
Sejak pengumuman penghentian kami pada Juni 2022, API 3.1 dan API 3.0, yang disebut sebagai 3.x, sudah tidak digunakan lagi. Versi API 3.x akan dinonaktifkan mulai dari rilis Looker versi 23.14 pada Agustus 2023.
Upgrade ini akan diluncurkan ke instance yang dihosting Looker selama jam pemeliharaan antara 14 Agustus hingga 24 Agustus. Akibatnya, semua instance yang dihosting Looker harus mengupgrade aplikasinya agar menggunakan endpoint 4.0 API, bukan endpoint API 3.x sebelum 14 Agustus 2023. Setiap fungsi yang mengandalkan endpoint 3.x akan berhenti berfungsi setelah perubahan ini.
Jika instance dihosting sendiri, Anda harus mengupgrade aplikasi sebelum mengupgrade instance Looker ke versi 23.14 atau yang lebih baru.
API 4.0 sepenuhnya mencakup fungsionalitas yang ditawarkan oleh API yang dihentikan, dan kami berharap upgrade dari 3.x ke 4.0 mudah dilakukan bagi sebagian besar pelanggan.
Pelanggan yang tidak berhasil bermigrasi ke API 4.0 harus menghubungi Dukungan Looker.
Linimasa
- Pra-2022: API 3.0 dalam status tidak digunakan lagi, 3.1 dalam status stabil, dan 4.0 dalam status beta
- Maret 2022: API 4.0 memasuki status stabil dan tersedia secara umum di Looker 22.4
- Juni 2022: Penghentian API 3.1 diumumkan
- Agustus 2023: API 3.x akan dinonaktifkan di Looker
Siapa yang harus membaca ini?
Dokumen ini ditujukan untuk Anda jika Anda menggunakan Looker API melalui SDK yang didukung Looker, SDK yang didukung Komunitas, atau API itu sendiri. Lanjutkan membaca untuk mempelajari perubahan yang dapat menyebabkan gangguan yang dapat memengaruhi aplikasi Anda dan mempelajarinya
Apa yang harus saya lakukan?
Anda harus membuat perubahan berikut pada kode. Hal ini akan dijelaskan lebih lanjut di bawah. - Ubah kode Anda agar mengarah ke API baru - Identifikasi penggunaan endpoint yang dihapus dan ganti referensi tersebut dengan API 4.0 yang setara - Perbarui nilai ID yang sebelumnya dinyatakan sebagai angka untuk dinyatakan sebagai string
Detail Migrasi API 4.0
Mengubah kode agar mengarah ke API baru
Saat melakukan panggilan API secara langsung melalui command line atau program seperti Postman, Anda harus menyesuaikan URL yang digunakan untuk membuat permintaan.
### API 3.1 ###
GET https://myinstance.looker.com/api/3.1/users/5877
### API 4.0 ###
GET https://myinstance.looker.com/api/4.0/users/5877
Jika Anda menggunakan salah satu SDK kami, pastikan Anda melakukan inisialisasi versi SDK yang benar. Berikut adalah contoh dasar tentang tampilan awal skrip Python menggunakan SDK kami di kedua versi:
### API 3.1 ###
import looker_sdk
sdk = looker_sdk.init31()
### API 4.0 ###
import looker_sdk
sdk = looker_sdk.init40()
Setelah Anda membuat perubahan pada API 4.0, saatnya untuk menguji kode Anda dan menantikan perubahan yang disebutkan di bawah ini.
Penggantian Endpoint API 3.x
Untuk menjaga konsistensi terminologi antara Looker API dan Looker UI, API 4.0 menggantikan beberapa endpoint API 3.x yang tidak digunakan lagi dengan endpoint yang setara atau lebih baik, yang tercantum di bawah ini:
Nama endpoint "Spasi" telah diganti. Gunakan endpoint "Folder" yang mirip sebagai gantinya.
- Tinjau dokumentasi fitur folder.
- Lihat daftar endpoint API folder.
Contoh Python SDK
#####################
##### API 3 #########
#####################
# Create Folder in Shared Folders
response = sdk.create_space(
body=mdls.CreateSpace(
name="My New Folder",
parent_id="1"
)
)
# Get Folder info by ID
response = sdk.space(space_id="555")
# Change name of existing Folder
response = sdk.update_space(
space_id="555",
body=mdls.UpdateSpace(
name="My Updated Folder"
)
)
#####################
##### API 4 #########
#####################
# Create Folder in Shared Folders
response = sdk.create_folder(
body=mdls.CreateFolder(
name="My New Folder",
parent_id="1"
)
)
# Get Folder info by ID
response = sdk.folder(folder_id="555")
# Change name of existing Folder
response = sdk.update_folder(
space_id="555",
body=mdls.UpdateFolder(
name="My Updated Folder"
)
)
Contoh cURL
#####################
##### API 3 #########
#####################
# Get Folder info by ID
curl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/3.1/spaces/555
# Change name of existing Folder
curl -X PATCH https://myinstance.looker.com/api/3.1/spaces/555 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"name\": \"My Updated Space\"}"
#####################
##### API 4 #########
#####################
# Get Folder info by ID
curl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/4.0/folders/555
# Change name of existing Folder
curl -X PATCH https://myinstance.looker.com/api/4.0/folders/555 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"name\": \"My Updated Space\"}"
Endpoint "Halaman beranda" telah dihapus. Sebagai gantinya, gunakan endpoint "board" fungsi yang diperluas.
- Tinjau dokumentasi fitur papan.
- Lihat daftar endpoint API board.
Contoh Python SDK
#####################
##### API 3 #########
#####################
# Get Board info by ID
response = sdk.homepage(homepage_id=1348)
# Update displayed title of Board item
response = sdk.update_homepage_item(
homepage_item_id=86,
body=mdls.WriteHomepageItem(
custom_title="Volume 3"
)
)
#####################
##### API 4 #########
#####################
# Get Board info by ID
response = sdk.board(board_id=1348)
# Update displayed title of Board item
response = sdk.update_board_item(
board_item_id=86,
body=mdls.WriteBoardItem(
custom_title="Volume 3"
)
)
Contoh cURL
#####################
##### API 3 #########
#####################
# Get Board info by ID
curl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/3.1/homepages/1348
# Update displayed title of Board item
curl -X PATCH https://myinstance.looker.com/api/3.1/homepage_items/86 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"custom_title\": \"Volume 3\"}"
#####################
##### API 4 #########
#####################
# Get Board info by ID
curl -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" https://myinstance.looker.com/api/4.0/boards/1348
# Update displayed title of Board item
curl -X PATCH https://myinstance.looker.com/api/4.0/boards/86 -H "Authorization: token Tg7gjGZD7B8c3k7g6XtmbcyYrQgMrXpjkR25dQ2G" -H "Content-Type: application/json" -d "{\"custom_title\": \"Volume 3\"}"
Jenis Kolom ID yang Dapat Menyebabkan Gangguan API 4.0
API 4.0 telah memperbarui jenis untuk beberapa kolom ID dari angka hingga string. Gunakan alat perbedaan referensi API kami untuk mengetahui kolom ID mana yang berubah antara 3.1 dan 4.0. Gunakan SDK bahasa yang didukung Looker terbaru (23.0+) untuk memastikan aplikasi Anda memiliki jenis yang benar selama dan setelah migrasi. Sebagian besar SDK bahasa yang didukung komunitas, termasuk Kotlin, Swift, R, C#, dan Go, juga sudah berfungsi dengan jenis yang diupdate.
Developer yang menggunakan library kustom harus menelusuri kode mereka untuk referensi ke kolom ini guna memastikan bahwa mereka ditangani dengan tepat.
Perbedaan API 4.0
Selain panduan di atas, Looker API Explorer menyediakan listingan lengkap tentang semua perbedaan antara API 3.x dan API 4.0.
Menonaktifkan/Mengaktifkan API 3.x melalui Tombol Fitur Lama
Untuk pelanggan yang dihosting Looker yang menggunakan Looker 23.6, 23.8, 23.10, dan 23.12, Admin saat ini memiliki kemampuan untuk menonaktifkan semua panggilan ke endpoint API 3. Dengan demikian, Anda dapat melakukan pengujian pada instance untuk memastikan tidak ada layanan atau aplikasi terintegrasi yang dihentikan sebelum batas waktu 14 Agustus. Untuk melakukannya, Anda dapat mengaktifkan "Tolak permintaan API 3.x" di panel Admin Fitur Lama.
Pelanggan yang dihosting sendiri yang menggunakan Looker 23.6, 23.8, 23.10, dan 23.12 dapat menjalankan perintah shell berikut sebelum memulai Looker untuk menambahkan variabel lingkungan yang akan membuat tombol "Deny API 3.x requests" terlihat (Catatan: Setelah menjalankan perintah, Anda masih harus mengalihkan tombol di panel Fitur Lama di UI Looker untuk menghentikan panggilan API 3.
export FF_DENY_API3=true
FAQ
Saya tidak yakin apakah ada panggilan API 3.x yang dilakukan pada instance saya. Bagaimana cara menemukan informasi ini?
Mulai Looker 23.8, kolom Sumber di panel Admin > Kueri kini menampilkan versi API (v3 atau v4) dengan benar untuk kueri yang dimulai dari Looker API. Hal ini tidak akan menyertakan informasi tentang tugas Admin atau Developer seperti membuat pengguna atau tugas pengembangan/Git LookML.
Layanan pelaporan internal kami memiliki informasi yang lebih mendetail terkait permintaan API, termasuk yang digunakan untuk menyelesaikan tugas Pengembangan Admin dan LookML. Pelanggan dengan instance yang mengikuti konfigurasi jaringan yang direkomendasikan dapat menghubungi Dukungan Looker untuk meminta ekspor data ini.
Saya menghosting instance saya sendiri. Apakah saya harus melakukan upgrade paling lambat 14 Agustus 2023?
Jika instance dihosting sendiri, Anda harus melakukan perubahan sebelum mengupgrade ke rilis Agustus 2023 (versi 23.14) atau rilis berikutnya. Sebaiknya mulai lakukan pekerjaan ini sesegera mungkin, agar Anda dapat terus menggunakan rilis yang didukung untuk mendapatkan pengalaman terbaik dengan Looker.
Instance saya dihosting Looker, tetapi berada pada program ESR. Apakah saya harus melakukan upgrade paling lambat 14 Agustus 2023?
Anda harus melakukan perubahan sebelum instance diupgrade ke rilis Agustus 2023 (versi 23.14) atau rilis berikutnya. Sebaiknya mulai lakukan pekerjaan ini sesegera mungkin agar Anda tidak perlu menentukan waktu kapan instance Anda dijadwalkan untuk menerima upgrade tersebut.
Saya telah membaca dokumentasinya, tetapi masih mengalami masalah atau tidak yakin dengan cara melanjutkan.
Pelanggan yang tidak berhasil bermigrasi ke API 4.0 harus menghubungi Dukungan Looker.