Ikhtisar
Apa yang akan Anda pelajari
Tutorial ini memandu Anda melalui langkah-langkah dan contoh untuk membantu developer organisasi mengunggah, mengunduh, dan mempratinjau file di Drive dengan cepat.Tujuan pembelajaran
Membantu developer membangun aplikasi mereka sendiri dengan cepat dan mengintegrasikan kemampuan unggah, pratinjau, serta unduh file Drive dengan memanggil API dasar DingTalk.Target pembaca
Semua developer DingTalk.Prasyarat
- Anda telah memperoleh izin developer.
- Anda telah menginstal IDE atau alat pengembangan lainnya.
- Anda telah membuat folder bernama “Test Folder” di Drive khusus untuk keperluan pengujian.
- Anda telah menginstal Node.js dan menyelesaikan konfigurasi lingkungan.
- Anda telah menginstal Maven dan menyelesaikan konfigurasi lingkungan.
- Anda telah menginstal JDK dan menyelesaikan konfigurasi lingkungan.
Alur pengembangan
- Gunakan Login senyap untuk memperoleh nama dan peran pengguna yang sedang masuk. Untuk proses masuk, lihat Login senyap untuk web app (H5 micro app).
-
Unggah file ke Drive.
- Panggil API Pencarian File untuk mencari folder bernama “Test Folder” di Drive dan mengembalikan
dentryUuidfolder tersebut.
- Panggil API Pencarian File untuk mencari folder bernama “Test Folder” di Drive dan mengembalikan
Catatan
Sebelum memanggil API ini, pastikan hanya ada satu folder bernama “Test Folder” di Drive. Jika tidak, error dapat terjadi. 2. Panggil API Get File Upload Information dengandentryUuid untuk memperoleh informasi unggah file, termasuk nilai parameter resourceUrls dan headers.
3. Unggah file menggunakan metode OSS header sign request. Untuk detailnya, lihat langkah 2 pada API Get File Upload Information.
4. Panggil API Submit File untuk mengirim file ke Drive dan memperoleh nilai parameter spaceId, parentId, path, dan uuid yang dikembalikan.
3. Pratinjau file di Drive.
-
Gunakan
uuidyang diperoleh dari pengiriman terakhir saat mengunggah file untuk menyusun URL dan membuka file untuk pratinjau. -
Unduh file dari Drive.
-
Panggil API Get Space List untuk memperoleh informasi ruang Drive, termasuk
spaceId. -
Panggil API Get File or Folder List dengan
spaceIduntuk memperolehfileIddan nama filename. -
Panggil API Get File Download Information dengan
fileIddannameuntuk memperoleh informasi unduh file, termasuk nilai parameterinternalResourceUrlsdanheaders. - Gunakan informasi di atas untuk melakukan pengunduhan. Untuk kode unduh, lihat langkah 2 pada Get File Download Information. Catatan
-
Panggil API Get Space List untuk memperoleh informasi ruang Drive, termasuk
Catatan
Path file adalah path proyek saat ini ditambah nama file. Oleh karena itu, setelah file diunduh, file akan otomatis tersimpan ke direktori proyek. Periksa sesuai kebutuhan.Langkah 1: Buat aplikasi
- Masuk ke Developer Console.
- Klik App Development > Internal App > DingTalk App > Create App.
-
Masukkan informasi aplikasi.
- Klik Save untuk masuk ke halaman detail aplikasi. Setelah dibuat, klik Basic Information > Credentials and Basic Information untuk melihat Client ID, Client Secret, dan Agent ID aplikasi.
Langkah 2: Konfigurasikan web app
- Pada halaman detail aplikasi, klik App Capabilities > Add App Capability.
- Pilih Add web app.
-
Konfigurasikan informasi web app (H5):
- Setelah konfigurasi selesai, klik Save.
Langkah 3: Tambahkan izin API
Untuk pengujian formal, tambahkan izin berikut:- Izin Pencarian File:
Storage.Dentry.Search - Izin baca informasi unggah file penyimpanan organisasi:
Storage.UploadInfo.Read - Izin tulis file penyimpanan organisasi:
Storage.File.Write - Izin baca ruang aplikasi Drive:
Drive.Space.Read - Izin baca file penyimpanan organisasi:
Storage.File.Read - Izin baca informasi unduh file penyimpanan organisasi:
Storage.DownloadInfo.Read
Langkah 4: Rilis aplikasi
- Setelah konfigurasi aplikasi selesai, Anda perlu merilis aplikasi. Pada halaman detail aplikasi, klik App Release > Version Management and Release.
- Klik Create New Version untuk masuk ke halaman detail versi.
-
Konfigurasikan informasi versi:
Setelah konfigurasi selesai, klik Save di bagian bawah.
-
Pada halaman dialog berhasil, klik Publish secara langsung.
Jika Anda bukan Admin Organisasi, merilis aplikasi memerlukan persetujuan dari Admin Organisasi. Merilis untuk visibilitas kepada diri sendiri saja tidak memerlukan persetujuan admin.
Langkah 5: Bangun layanan
- Pastikan Anda telah menyelesaikan langkah-langkah di atas dan memperoleh informasi parameter yang diperlukan untuk menjalankan demo berikut.
- Unduh demo file-demo.zip.
-
Buka IDE dan impor demo yang telah diunduh.
Kode contoh dibagi menjadi backend (direktori kode backend) dan frontend (direktori kode frontend).
-
Buka direktori kode backend. Di direktori resources, edit file
application.propertiesdan masukkan parameterclientId (app Client ID)danclientSecret (app Client Secret). -
Klik untuk memulai layanan backend.
Catatan
- Sebelum memulai layanan backend, pastikan Maven dan JDK terinstal dengan benar dan lingkungan terkait telah dikonfigurasi. Jika ini pertama kalinya Anda menginstal IDE, ubah file konfigurasi terkait di IDE.
- Pastikan port 5173 dan 8080 tidak sedang digunakan.
-
Buka direktori kode frontend, edit
vite.config.ts, dan masukkanclientId (app Client ID)yang benar. - Klik file proyek frontend, klik kanan, dan pilih Terminal untuk membukanya.
-
Di jendela terminal, jalankan perintah berikut:
-
npm install -
npm run devCatatan: Pada Windows, gunakan
npm run dev:rawuntuk memulai.
-
- Layanan frontend dan backend kini telah berhasil dimulai.
Langkah 6: Uji aplikasi
- Masuk ke DingTalk Sisi klien dan pilih organisasi tempat aplikasi berada.
- Klik Workbench > Add, cari aplikasi organisasi yang Anda buat di atas, lalu tambahkan.
- Buka aplikasi dan klik Select Local File untuk mengunggah file lokal ke Drive. Setelah memilih file, klik Submit. Pada halaman konfirmasi informasi file, Anda dapat melihat ID pengguna, Nama File, dan Ukuran File.
- Setelah unggah berhasil, hasilnya ditampilkan seperti di bawah ini:
Catatan
Anda dapat mengklik tautan untuk membuka file secara langsung, atau mengklik tombol Open File untuk melihat file. Setelah unggah berhasil, Anda dapat melihat file yang diunggah di “Test Folder” pada Drive.- Klik tombol unduh file untuk mengunduh file.
Penting
Jika Pesan error “auth level of org is not enough” muncul saat mengunduh file, ini menandakan bahwa level autentikasi organisasi saat ini terlalu rendah dan perlu ditingkatkan sebelum digunakan. Untuk detailnya, lihat deskripsi Kode error pada API Get File Download Information. Setelah unduh berhasil, Anda dapat melihat file yang diunduh di direktori proyek.- Anda kini telah menyelesaikan semua operasi untuk mengunggah, mempratinjau, dan mengunduh file di Drive.