Налаштуйте та використовуйте Canva API адміністратора

За допомогою Canva Admin API можна автоматизувати керування організацією у власних системах. Керуйте користувачами, командами, групами й членством, а також отримуйте події з журналу дій, не виконуючи ці завдання вручну в Canva.

• Доступно в тарифних планах Canva для великих підприємств, Canva Districts і Canva для студмістечка.
• Доступно адміністраторам організації.
• Доступно організаціям з однією або кількома командами.

Перш ніж налаштувати Admin API, переконайтеся, що ваша організація відповідає таким вимогам:

• Рівень організації: Admin API працює на рівні організації. Він доступний організаціям з однією або кількома командами в тарифних планах Canva для великих підприємств, Canva Districts і Canva для студмістечка.
• Обліковий запис адміністратора організації: Лише адміністратори організації можуть створювати клієнти Admin API та керувати ними в налаштуваннях Canva.
• Власна команда розробників або залучені фахівці: для створення й підтримки інтеграції організації потрібні ресурси для розробки. Canva не надає підтримку з упровадження.
  • Якщо ваша команда не може працювати з API, для автоматизації керування користувачами в організації краще підійде підготовка через SCIM.
• Знання структури Canva: перш ніж створювати інтеграцію, з’ясуйте, як у Canva налаштовано вашу організацію, команди й групи.
• Багатофакторна автентифікація (MFA) або обліковий запис, керований через єдиний вхід: адміністратор організації, який налаштовує Admin API, має ввімкнути MFA або використовувати обліковий запис, керований через єдиний вхід. Обліковий запис має належати організації, від імені якої діє адміністратор, або керуватися нею.

В Admin API доступні такі кінцеві точки:

• Користувачі, команди й групи: створення, читання, оновлення та видалення.
• Членство: додавання людей до команд і груп та вилучення з них, а також призначення ролей.
• Журнали дій: отримання подій із журналу дій за розкладом.
• Запрошення до команд: запрошення людей до команди, зокрема тих, хто не входить до вашої організації; перегляд запрошень, що очікують на прийняття; отримання наявного посилання-запрошення за точною адресою електронної пошти; скасування запрошень.

Адміністратор організації створює клієнт Admin API та використовує його для надсилання запитів до API.

Дивіться документацію Canva Admin API, щоб обміняти облікові дані клієнта на маркер доступу й почати надсилати запити до API.

Щоб дізнатися більше про автентифікацію запитів до API та використання токенів доступу OAuth 2.0 типу bearer, надішліть команді розробників документацію з автентифікації Canva Admin API.

Дії, виконані через Admin API, записуються за клієнтом Admin API, а не за адміністратором, який його викликав.

У журналах дій у полі «Виконавець» відображаються назва й ідентифікатор клієнта Admin API. Це допомагає визначити, яка інтеграція виконала дію.

Також можна дізнатися, який адміністратор організації створив, оновив або видалив певний клієнт API.

Докладніше див. в статті «Про журнали дій Canva».

Адміністратори організації можуть запрошувати людей до команди через Admin API, зокрема зовнішніх співробітників, які не входять до вашої організації.

Що потрібно знати

• Кожне створене запрошення стосується однієї команди й однієї адреси електронної пошти.
• Кожне запрошення можна використати один раз; термін його дії — 30 днів.
• Залежно від налаштувань Canva може не надіслати запрошеній людині електронного листа автоматично. За потреби надішліть їй посилання-запрошення безпосередньо.
• Не розголошуйте посилання-запрошення. Воно працює лише для адреси електронної пошти, для якої його створено.
• До запрошених людей застосовуються наявні налаштування запрошень і доменів вашої команди.
• Якщо для запрошеної людини вже є запрошення, яке очікує на прийняття, створення нового запрошення поверне той самий запис запрошення. Термін його дії буде відраховуватися заново — 30 днів від моменту запиту, а роль у запрошенні зміниться на запитану.

Докладніше про кінцеві точки див. в документації Canva Admin API.

І Admin API, і SCIM можна використовувати для підготовки користувачів.

Admin API дає змогу керувати організацією Canva не лише під час підготовки користувачів. Зокрема, можна керувати командами, групами, членством і журналами дій.

SCIM підтримує стандартну підготовку й скасування підготовки. Якщо вам потрібна лише стандартна підготовка користувачів або ваша команда не може створити власну інтеграцію з API, SCIM краще відповідатиме вашим потребам.

Чи потрібен моїй організації розробник для роботи з Admin API?

Так. Для створення й підтримки інтеграції організації потрібні власні або залучені фахівці з розробки. Canva не надає підтримку з упровадження. Якщо ваша команда не може працювати з API, для автоматизації керування користувачами в організації краще підійде підготовка через SCIM.

Чи потрібні MFA або єдиний вхід усім в організації для роботи з Admin API?

Ні. Лише адміністратор організації, який налаштовує Admin API, має ввімкнути MFA або використовувати обліковий запис, керований через єдиний вхід. Обліковий запис має належати організації, від імені якої діє адміністратор, або керуватися нею. Іншим учасникам організації MFA чи єдиний вхід не потрібні для роботи Admin API.

Чи може наша організація запрошувати зовнішніх співробітників через Admin API?

Так. Адміністратори організації можуть запрошувати людей до команд через Admin API, зокрема зовнішніх співробітників. До запрошених людей застосовуються наявні налаштування запрошень і доменів вашої команди.

Чи можна повторно отримати наявне посилання-запрошення, не створюючи нового запрошення?

Так. Наявне посилання-запрошення можна отримати за точною адресою електронної пошти запрошеної людини, не створюючи нового запрошення.