Siapkan dan gunakan Canva Admin API

Anda dapat menggunakan Admin API Canva untuk mengotomatiskan pengelolaan organisasi melalui sistem Anda sendiri. Kelola pengguna, tim, grup, dan keanggotaan, serta ambil peristiwa log audit tanpa harus melakukan tugas-tugas ini secara manual di Canva.

• Tersedia untuk Canva Perusahaan, Canva Distrik, dan Canva Kampus.
• Dapat diakses oleh administrator organisasi.
• Tersedia untuk organisasi dengan satu atau beberapa tim.

Sebelum menyiapkan Admin API, pastikan organisasi Anda memenuhi persyaratan berikut:

• Lapisan organisasi: Admin API memiliki cakupan organisasi. Fitur ini tersedia untuk organisasi dengan satu atau beberapa tim yang menggunakan paket Canva Perusahaan, Canva Distrik, dan Canva Kampus.
• Akun administrator organisasi: Hanya administrator organisasi yang dapat membuat dan mengelola klien Admin API di pengaturan Canva.
• Tim teknis internal atau alih daya: Organisasi Anda memerlukan sumber daya teknis untuk membangun dan memelihara integrasi. Canva tidak menyediakan dukungan implementasi.
  • Jika tim Anda tidak dapat mengembangkan integrasi menggunakan API, penyediaan SCIM lebih cocok untuk mengotomatiskan pengelolaan pengguna di organisasi Anda.
• Memahami struktur Canva Anda: Sebelum membangun integrasi, pastikan Anda memahami dengan jelas bagaimana organisasi, tim, dan grup Anda diatur di Canva.
• Akun yang dikelola dengan Autentikasi Multifaktor (MFA) atau Sistem Masuk Tunggal (SSO): Administrator organisasi yang mengonfigurasi Admin API harus mengaktifkan MFA atau menggunakan akun yang dikelola melalui SSO. Akun tersebut harus dikelola atau dimiliki oleh organisasi yang diwakilinya.

Admin API menyediakan endpoint untuk:

• Pengguna, Tim, dan Grup: Membuat, membaca, memperbarui, dan menghapus.
• Keanggotaan: Menambahkan atau menghapus anggota dari tim dan grup, serta menetapkan peran mereka.
• Log audit: Mengambil peristiwa log audit sesuai jadwal.
• Undangan tim: Mengundang orang ke tim (termasuk orang di luar organisasi Anda), melihat undangan yang tertunda, mengambil tautan undangan yang sudah ada berdasarkan alamat email yang persis, dan membatalkan undangan.

Administrator organisasi membuat klien Admin API dan menggunakannya untuk memanggil API.

Ikuti dokumentasi Admin API Canva untuk menukar kredensial klien Anda dengan token akses dan mulai mengirim permintaan API.

Untuk mengetahui detail teknis tentang autentikasi permintaan API dan penggunaan token bearer OAuth 2.0, bagikan dokumentasi Autentikasi Admin API Canva kepada tim teknis Anda.

Tindakan yang dilakukan melalui Admin API dicatat atas nama klien Admin API, bukan administrator yang menjalankan klien tersebut.

Di log audit, kolom Aktor menampilkan nama dan ID klien Admin API. Dengan begitu, Anda dapat mengetahui integrasi mana yang melakukan suatu tindakan.

Anda juga dapat mengetahui administrator organisasi yang membuat, memperbarui, atau menghapus klien API tertentu.

Untuk informasi selengkapnya, lihat Tentang log audit Canva.

Administrator organisasi dapat menggunakan Admin API untuk mengundang orang ke tim, termasuk kolaborator eksternal di luar organisasi Anda.

Hal yang perlu diketahui

• Setiap undangan yang Anda buat berlaku untuk satu tim dan satu alamat email.
• Setiap undangan hanya dapat digunakan sekali dan kedaluwarsa setelah 30 hari.
• Bergantung pada pengaturan Anda, Canva mungkin tidak otomatis mengirim email kepada orang yang diundang. Jika perlu, bagikan tautan undangan langsung kepada orang tersebut.
• Jaga kerahasiaan tautan undangan. Tautan undangan hanya berlaku untuk alamat email yang digunakan saat tautan dibuat.
• Pengaturan undangan dan domain yang sudah ada di tim Anda tetap berlaku bagi orang yang Anda undang.
• Jika sudah ada undangan tertunda untuk orang tersebut, membuat undangan baru akan menampilkan catatan undangan yang sama. Masa berlakunya akan diatur ulang menjadi 30 hari sejak permintaan, dan peran undangan akan diperbarui sesuai peran yang diminta.

Untuk detail endpoint, lihat dokumentasi Admin API Canva.

Admin API dan SCIM sama-sama dapat mendukung penyediaan pengguna.

Admin API mendukung pengelolaan organisasi Canva yang lebih luas daripada sekadar penyediaan pengguna. Ini mencakup tim, grup, keanggotaan, dan log audit.

SCIM mendukung penyediaan dan pencabutan akses dengan cara standar. Jika Anda hanya memerlukan penyediaan pengguna standar atau tim Anda tidak dapat membangun integrasi API khusus, SCIM lebih sesuai dengan kebutuhan Anda.

Apakah organisasi saya memerlukan developer untuk menggunakan Admin API?

Ya. Untuk menggunakan Admin API, organisasi Anda harus memiliki sumber daya teknis internal atau alih daya untuk membangun dan memelihara integrasi. Canva tidak menyediakan dukungan implementasi. Jika tim Anda tidak dapat mengembangkan integrasi menggunakan API, penyediaan SCIM lebih cocok untuk mengotomatiskan pengelolaan pengguna di organisasi Anda.

Apakah semua orang di organisasi saya harus menggunakan MFA atau SSO agar dapat memakai Admin API?

Tidak. Hanya administrator organisasi yang mengonfigurasi Admin API yang harus mengaktifkan MFA atau menggunakan akun yang dikelola melalui SSO. Akun tersebut harus dikelola atau dimiliki oleh organisasi yang diwakilinya. Anggota organisasi lainnya tidak perlu menggunakan MFA atau SSO secara khusus agar Admin API berfungsi.

Dapatkah organisasi saya mengundang kolaborator eksternal menggunakan Admin API?

Ya. Administrator organisasi dapat menggunakan Admin API untuk mengundang orang ke tim, termasuk kolaborator eksternal. Pengaturan undangan dan domain yang sudah ada di tim Anda tetap berlaku bagi orang yang Anda undang.

Dapatkah kami mengambil kembali tautan undangan yang sudah ada tanpa membuat undangan baru?

Ya. Anda dapat mengambil tautan undangan yang sudah ada menggunakan alamat email orang yang diundang secara persis, tanpa membuat undangan baru.