Эта статья была переведена с английского с помощью машинного перевода.
Если в вашей команде есть разработчик, который знает, как использовать API GraphQL, API Webex Events может стать для вас воротами к мощным средствам автоматизации настройки и управления событиями и продуктами, интеграции сторонних платформ, мощным информационным панелям данных о нескольких событиях и многому другому. .
Возможности API Webex Events
Проще говоря, API — это программный интерфейс, который разработчики могут использовать для получения или размещения данных на онлайн-платформе — в данном случае Webex Events.
Возможности API можно упростить до четырех основных концепций:
Создайте что-то, чего раньше не существовало, например участника, сеанс или целое событие.
Обновите все, что можно создать с помощью API, а также еще несколько вещей. Например, API можно использовать для создания нового участника, а затем редактировать его имя, адрес электронной почты, статус, группы, номера телефонов и учетные записи в социальных сетях.
Прочтите информацию обо всем, что API может использовать для создания или редактирования, а также о некоторых вещах, которые он не может использовать.
Удалите все, что можно создать с помощью API, за некоторыми исключениями.
Помните об этих понятиях, читая раздел «Работа с разработчиками» этой статьи.
С чего начать
1. Получите доступ к API
Если вы являетесь клиентом соглашения Webex Suite Enterprise (Suite EA), у которого уже активирована Webex Events , вы автоматически получаете доступ к API Webex Events ! Для всех остальных клиентов обратитесь к своему контактному лицу в Webex Events или в нашу службу поддержки, чтобы узнать о доступе к API.
2. Создайте ключ API
Теперь вам нужно создать новый ключ API, который смогут использовать ваши разработчики. Если у вас есть доступ к API, на странице «Настройки организации» на платформе Webex Events добавляется новая вкладка. Вот как получить доступ к новой вкладке и создать свой первый ключ:
💡 Имейте в виду, что доступ к странице API имеют только администраторы организации.
В любом месте платформы Webex Events щелкните изображение своего профиля в правом верхнем углу экрана, а затем выберите «Настройки организации» в раскрывающемся списке.
На странице настроек организации перейдите на вкладку API в левом меню. Вы попадете на панель управления API, где сможете просмотреть использование API, экспортировать журналы использования, управлять ключами и получить доступ к нашей документации по API.
Нажмите Создать ключ .
В модальном окне «Создать новый ключ» введите метку для ключа API, объясняющую, для чего он будет использоваться.
В раскрывающемся списке «Версия API» уже будет выбрана текущая версия, поэтому просто нажмите «Сохранить» . Это покажет ключ API.
Нажмите кнопку «Копировать» рядом с ключом и вставьте ключ в защищенный документ, чтобы он никогда не потерялся.
⚠️ВНИМАНИЕ ! Это единственный раз, когда можно получить доступ к полному ключу API. После закрытия модального окна полный ключ невозможно будет прочитать снова.
После того, как вы скопировали и сохранили ключ, нажмите кнопку «Закрыть» .
В большинстве случаев вам нужен только один ключ API. Однако в ситуациях, когда вы работаете с несколькими командами, вам может потребоваться создать ключ для каждой команды. Поговорите со своими разработчиками о конкретных вариантах использования, чтобы найти лучшее решение.
3. Пригласите разработчиков получить доступ к API.
При создании первого ключа API на платформе Webex Events автоматически создается новая группа API. Предоставить своим разработчикам доступ для опробования API Webex Events так же просто, как пригласить их в эту группу API. Следуйте инструкциям в нашей статье об управлении командами, участниками и кредитами, чтобы узнать, как это сделать.
💡 Имейте в виду, что песочница API — это отдельная версия платформы Webex Events , созданная специально для тестирования. Это означает, что все новые члены группы API Sandbox должны создать новую учетную запись платформы для использования песочницы, даже если у них уже есть учетная запись платформы или они входят в систему с помощью единого входа своей организации.
Люди из вашей команды API не имеют доступа к остальной части платформы Webex Events , как это делают организаторы. Вместо этого члены команды API имеют доступ к «песочнице» API, где они могут тестировать то, что они создают, не затрагивая реальные данные. Если вы хотите, чтобы разработчики также имели доступ к некоторым или всем вашим реальным событиям и приложениям на платформе Webex Events , пригласите их в соответствующие команды, не использующие API.
4. Подготовьте мероприятие
Поскольку API не может активировать ни один из продуктов на мероприятии, например Event App и Onsite, вы должны активировать каждый продукт, который вы собираетесь использовать на своем мероприятии, заполнив основную необходимую информацию.
Работа с разработчиками
Вам важно четко общаться с разработчиками, чтобы они могли создать то, что вам нужно. Это означает, что вам необходимо знать, к каким частям платформы Webex Events может получить доступ API. Продолжайте читать, чтобы узнать, к чему именно API может получить доступ и что можно контролировать, а также несколько советов, которые помогут вам «говорить на одном языке» с вашим разработчиком.
Ознакомившись с базовыми возможностями, вы можете начать обсуждать со своим разработчиком вопросы создания инструментов и автоматизации с помощью API.
Команды и организации
Создание, обновление, чтение и удаление команд и участников команд.
События
Создавайте, обновляйте, клонируйте и читайте. События нельзя удалить.
Участники
Создавайте, обновляйте, читайте, назначайте сеансам, назначайте группам и удаляйте информацию социальных учетных записей (номер телефона, дескрипторы социальных учетных записей и т. д.). Участников нельзя удалить, но их можно заблокировать.
Вопросы
Создание, обновление, чтение и удаление
Совет. В API вопросы называются «настраиваемыми полями».
Группы
Создание, обновление, чтение и удаление как эксклюзивных, так и неэксклюзивных групп.
Сессии
Создание, обновление, чтение и удаление
Локации
Создание, обновление, чтение и удаление
Совет: В API местоположения называются «регионами».
Branded Apps
Чтение названий Branded App , статусов и названий назначенных событий.
Event App
Прочтите настройки «Основы», «Внешний вид» и «Веб-приложение», а также информацию о записях Video Center .
Создайте, обновите, прочитайте и удалите следующие функции Event App и их элементы, если это применимо:
Повестка дня
Спонсоры
Динамики
Экспоненты
Прямая трансляция
Участники
Пользовательский список
Одиночный предмет
Интернет-ссылка
Веб-список
Мой QR-код
💡 Имейте в виду, что вам необходимо вручную добавлять и настраивать любые функции Event App, не перечисленные выше.
Совет: В API функции называются «компонентами».
Постановка на учет
Прочтите информацию об основах, внешнем виде и настройках, включая настройки оформления заказа.
Создавайте, читайте, обновляйте и удаляйте заявки, формы, вопросы, промокоды.
Создание, чтение и обновление заказов
Отправьте электронное письмо с подтверждением заказа и билета
Отметить заказы на чек или счет-фактуру как оплаченные
Обновить информацию о покупателе заказа
Отменить и вернуть билеты
Создавайте, читайте, обновляйте, удаляйте, приостанавливайте и возобновляйте промокоды.
Создание, чтение, обновление и удаление налогов
Совет: В API вопросы называются «настраиваемыми полями».
На Onsite
Чтение и обновление базовой информации и информации о Onsite App.
Lead Retrieval и Live Display
Узнайте, активен ли продукт или опубликован в Событии.
Что нужно знать
Время от времени мы будем выпускать новые версии API с улучшениями и исправлениями. Мы продолжим поддерживать старые версии достаточно долго, чтобы каждый мог перейти на новую версию. Мы будем отправлять по электронной почте обновления о новых версиях, датах предстоящего прекращения поддержки старых версий и официальном прекращении поддержки.
Запросы API измеряются и ограничиваются во избежание злоупотреблений.
Для клиентов Suite также поддерживаются сообщества.