Langsung ke konten utama
Sebelum memanggil Server API DingTalk, tambahkan izin pemanggilan API yang diperlukan. Setelah aplikasi dibuat, sistem memberikan izin API Autentikasi dan Notifikasi pesan secara default. Kami mendorong aplikasi untuk menggunakan sebanyak mungkin API agar tercapai interoperabilitas penuh dengan kapabilitas inti DingTalk.

Cakupan yang berlaku

  • Aplikasi internal: Aplikasi yang dikembangkan oleh organisasi untuk penggunaan internalnya sendiri. Cocok untuk skenario integrasi sistem internal.
  • Aplikasi perusahaan pihak ketiga: Aplikasi layanan yang dikembangkan oleh ISV (Independent Software Vendor) untuk dipasang dan digunakan oleh banyak pelanggan perusahaan.
  • Aplikasi personal pihak ketiga: Aplikasi yang dikembangkan oleh penyedia solusi untuk pengguna personal di DingTalk.
Prosedur permintaan izin, proses persetujuan, dan ketersediaan API dapat bervariasi menurut jenis aplikasi. Ikuti petunjuk yang sesuai dengan jenis aplikasi Anda.

Ikhtisar

Sebelum memanggil Server API DingTalk, tambahkan izin pemanggilan API yang sesuai ke aplikasi. Setelah aplikasi dibuat, sistem memberikan izin dasar tertentu secara default. Minta izin API yang diperlukan sesuai kebutuhan bisnis Anda untuk mencapai integrasi mendalam dengan kapabilitas inti DingTalk. Izin API diberikan di tingkat aplikasi, dan izin bersifat independen antaraplikasi. Meskipun beberapa aplikasi dalam organisasi yang sama perlu memanggil API yang sama, izin harus diminta secara terpisah untuk setiap aplikasi. Misalnya, jika organisasi Anda memiliki dua aplikasi, A dan B, dan aplikasi A sudah memiliki izin baca Kontak, aplikasi B tetap harus meminta izin Kontak secara terpisah untuk mengakses data Kontak. Prosedurnya sama seperti aplikasi A.
Tidak semua API dapat diaktifkan secara langsung. Beberapa API merupakan kapabilitas non-publik dan memerlukan persetujuan sebelum digunakan. API premium lainnya mungkin melibatkan biaya atau persyaratan kualifikasi tertentu. Lihat deskripsi cakupan pada masing-masing dokumen API untuk detailnya.

Prasyarat

Sebelum mengonfigurasi izin API, pastikan kondisi berikut terpenuhi:
  1. Jenis aplikasi adalah Aplikasi internal, Aplikasi perusahaan pihak ketiga, atau Aplikasi personal pihak ketiga, dan aplikasi telah dibuat di Developer Console.
  2. Akun saat ini memiliki izin pengelolaan untuk aplikasi (biasanya Admin Organisasi atau pemilik aplikasi).
  3. Organisasi telah menyelesaikan autentikasi (beberapa API memerlukan autentikasi organisasi dengan nama asli sebelum dapat diminta).
  4. AppKey dan AppSecret aplikasi telah diperoleh dan dikonfigurasi dengan benar untuk autentikasi API.

Menambahkan izin pemanggilan API standar

Prosedur ini berlaku untuk sebagian besar Server API publik dan dapat diminta langsung melalui Developer Console. Prosedur:
  1. Pada dokumen API, salin cakupan izin dari bagian Izin pada API yang dituju.
  2. Masuk ke Developer Console.
  3. Pada halaman App Development, klik aplikasi yang dituju untuk masuk ke halaman detail aplikasi.
  4. Pada halaman detail aplikasi, klik Kelola izin, cari cakupan izin yang telah disalin, lalu klik Minta izin.

Menambahkan izin pemanggilan API khusus

Untuk API non-publik, sensitif, atau khusus industri, diperlukan persetujuan manual oleh DingTalk sebelum dapat diaktifkan. Prosedur:
  1. Pada dokumen API, salin cakupan izin dari bagian Izin pada API yang dituju.
  2. Masuk ke Developer Console sebagai Admin.
  3. Pada halaman App Development, klik aplikasi yang dituju untuk masuk ke halaman detail aplikasi.
  4. Klik Kelola izin, pilih API khusus yang akan ditambahkan, lalu klik Minta izin.
  5. Masukkan deskripsi permintaan, lalu klik Request. Tips
    • Permintaan izin API ditinjau oleh tim DingTalk yang bertanggung jawab atas API terkait. Persetujuan biasanya selesai dalam satu hari kerja. Setelah disetujui, status berubah menjadi Diaktifkan.
    • Jika permintaan ditolak, temukan entri izin pada daftar Requests, arahkan kursor ke tag Review Failed untuk melihat alasan spesifik, lalu kirim ulang setelah melakukan perbaikan berdasarkan masukan.

Mengatasi kesalahan izin

Solusi ini untuk saat ini hanya berlaku untuk pemanggilan yang dilakukan ke Server API baru.
Ketika pemanggilan API baru mengembalikan kesalahan 403, isi respons berisi informasi terperinci tentang izin yang hilang:
Ketika aplikasi mengembalikan kesalahan “no permission to call this API”, ikuti langkah-langkah berikut:
  1. Ekstrak nilai bidang requiredScopes di dalam AccessDeniedDetail pada respons kesalahan. Ini adalah kode cakupan izin yang diperlukan oleh API yang dituju.
  2. Pada halaman Kelola izin aplikasi saat ini, cari kode cakupan izin tersebut, lalu minta izin API yang sesuai.

Penting