Настроить и использовать 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 или должна быть учетная запись с управлением через SSO. Учетная запись должна управляться организацией, от имени которой действует администратор, или принадлежать ей.

В 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?

Нет. MFA должна быть включена или учетная запись администратора организации, настраивающего Admin API, должна управляться через SSO. Учетная запись должна управляться организацией, от имени которой действует администратор, или принадлежать ей. Другим участникам организации не нужны MFA или SSO специально для работы Admin API.

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

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

Можно ли повторно получить ссылку на существующее приглашение, не создавая нового?

Да. Ссылку на существующее приглашение можно получить по точному адресу электронной почты приглашенного, не создавая новое приглашение.