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

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

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

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

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

Admin API надає кінцеві точки для таких дій:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Чи всім в організації потрібно використовувати MFA або єдиний вхід (SSO), щоб працювати з Admin API?

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

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

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

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

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