Siapkan dan gunakan Canva Admin API

Anda dapat menggunakan API Admin 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 Districts, dan Canva Kampus.
• Dapat diakses oleh administrator organisasi.
• Tersedia untuk organisasi dengan satu tim maupun beberapa tim.

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

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

API Admin 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 dengan alamat email yang persis, dan membatalkan undangan.

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

Ikuti dokumentasi API Admin 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 API Admin Canva kepada tim engineering Anda.

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

Dalam log audit, kolom Actor menampilkan nama dan ID klien API Admin. Ini membantu Anda mengidentifikasi integrasi yang melakukan suatu tindakan.

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

Untuk informasi selengkapnya, lihat Tentang log audit Canva.

Administrator organisasi dapat menggunakan API Admin 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.
• Tergantung pada pengaturan Anda, Canva mungkin tidak mengirim email kepada orang yang diundang secara otomatis. Jika perlu, bagikan tautan undangan secara langsung kepada orang tersebut.
• Jaga kerahasiaan tautan undangan. Tautan undangan hanya berlaku untuk alamat email yang digunakan saat membuatnya.
• 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 kembali data undangan yang sama. Masa berlakunya akan diatur ulang menjadi 30 hari sejak permintaan, dan peran undangan akan diperbarui sesuai peran yang diminta.

Untuk mengetahui detail endpoint, lihat dokumentasi API Admin Canva.

API Admin dan SCIM sama-sama mendukung penyediaan pengguna.

API Admin mendukung pengelolaan organisasi Canva di luar penyediaan pengguna. Ini mencakup tim, grup, keanggotaan, dan log audit.

SCIM mendukung penyediaan dan penghentian penyediaan standar. Jika Anda hanya memerlukan penyediaan pengguna standar atau tim Anda tidak dapat membangun integrasi API khusus, SCIM lebih cocok untuk kebutuhan Anda.

Apakah organisasi saya memerlukan developer untuk menggunakan API Admin?

Ya. Untuk menggunakan API Admin, organisasi Anda memerlukan sumber daya engineering internal atau eksternal guna membangun dan memelihara integrasi. Canva tidak menyediakan dukungan implementasi. Jika tim Anda tidak dapat membangun integrasi menggunakan API, penyediaan SCIM lebih cocok untuk mengotomatiskan pengelolaan pengguna di organisasi Anda.

Apakah semua orang di organisasi saya perlu menggunakan MFA atau SSO agar API Admin dapat digunakan?

Tidak. Hanya administrator organisasi yang mengonfigurasi API Admin yang harus mengaktifkan MFA atau memiliki 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 API Admin berfungsi.

Dapatkah organisasi saya mengundang kolaborator eksternal menggunakan API Admin?

Ya. Administrator organisasi dapat menggunakan API Admin 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.