Начало работы с API Webex Events
list-menuОтправить обратную связь?
Что делает API и с чего начать

Если в вашей команде есть разработчик, который знает, как использовать API GraphQL, API Webex Events может стать вашим ключом к мощным средствам автоматизации настройки и управления событиями и продуктами, интеграции сторонних платформ, мощным панелям управления данными по нескольким событиям и многому другому.

На что способен API Webex Events

Проще говоря, API — это программный интерфейс, который разработчики могут использовать для получения данных или их размещения на онлайн-платформе (в данном случае Webex Events).

Возможности API можно упростить до четырех основных понятий:

  • Создайте что-то, чего раньше не существовало, например участника, сеанс или целое мероприятие.

  • Обновите все, что можно создать с помощью API, а также кое-что еще. Например, с помощью API можно создать нового участника, а затем отредактировать его имя, адрес электронной почты, статус, группы, телефонные номера и учетные записи в социальных сетях.

  • Прочитайте информацию обо всем, для чего можно создавать или редактировать с помощью API, а также о том, что нельзя.

  • Удалите все, для создания чего можно использовать API, за некоторыми исключениями.

Помните об этих понятиях, читая раздел «Работа с разработчиками» этой статьи.

С чего начать

1. Получите доступ к API

Если вы являетесь клиентом Webex Suite корпоративного соглашения (Suite EA) и уже активировали Webex Events, вы автоматически получаете доступ к API Webex Events! Для всех остальных клиентов обратитесь к своему контактному лицу по Webex Events или в нашу службу поддержки, чтобы узнать, как получить доступ к API.

2. Создайте ключ API

Теперь вам нужно создать новый ключ API для использования разработчиками. Когда вы получаете доступ к API, новая вкладка добавляется на страницу «Настройки организации» на платформе Webex Events. Вот как открыть новую вкладку и создать первый ключ:

Помните, что только администраторы организации могут получить доступ к странице API.

  1. В любом месте платформы Webex Events нажмите на изображение профиля в правом верхнем углу экрана, а затем выберите Настройки организации в раскрывающемся списке.

  2. На странице настроек организации выберите вкладку API в левом меню. После этого вы перейдете на панель управления API, где вы сможете просматривать использование API, экспортировать журналы использования, управлять ключами и получать доступ к нашей документации по API.

  3. Нажмите «Создать ключ».

  4. В модальном окне «Создать новый ключ» введите метку ключа API, объясняющую, для чего он будет использоваться.

  5. В раскрывающемся списке версий API уже будет выбрана текущая версия, поэтому просто нажмите «Сохранить». Это откроет ключ API.

  6. Нажмите кнопку «Копировать» рядом с ключом и вставьте ключ в защищенный документ, чтобы он никогда не потерялся.

ВНИМАНИЕ! Это единственный случай, когда можно получить доступ к полному ключу API. После закрытия модального окна полный ключ невозможно будет снова прочитать.

  1. После копирования и сохранения ключа нажмите кнопку Закрыть.

В большинстве случаев вам нужен только один ключ 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. Станьте хорошим другом для своих разработчиков и дайте им достаточно времени, чтобы освоить API Webex Events, прежде чем ожидать от них интеграции. Они будут благодарны за то, что на них не давят.

Как минимум, мы рекомендуем начать разговор со своими разработчиками не менее чем за шесть месяцев до того, как интеграции начнут работать. Продолжайте читать, чтобы узнать, как подготовиться к этим разговорам и провести их.

Работа с разработчиками

После того как вы пригласите разработчиков в свою команду Webex Events Sandbox, одним из ваших первых вопросов может быть: «Сколько времени потребуется на создание интеграций?» Ответ на этот вопрос зависит от многих факторов, в том числе от количества разработчиков, с которыми вы работаете, сколько времени у них уходит на работу над интеграциями, сложность интеграций и многое другое.

Только ваши разработчики могут сказать вам, сколько времени потребуется на настройку интеграции, и только после выполнения нескольких важных шагов:

  1. Сначала ознакомьтесь с разделами ниже, чтобы узнать, на что способен API. Это поможет вам понять, что возможно, и четко сообщить разработчикам о своих потребностях.

  2. Познакомьтесь со своими разработчиками, поделитесь с ними нашей документацией по API и обсудите, что вам нужно. Они смогут дать основные отзывы о том, что они могут, а что нет. Однако они не смогут указать вам конкретные сроки, пока не ознакомятся с API Webex Events.

  3. Дайте разработчикам время ознакомиться с API. Будьте готовы ответить на концептуальные или практические вопросы о ваших событиях, данных, платформе Webex Events и обо всем остальном.

На что способен API

API имеет две основные функции:

  • Чтение. Получайте данные из Webex Events, чтобы их можно было изучить или перенести в другую систему.

  • Обновить — помещайте данные в Webex Events для создания новых элементов или синхронизации данных (например, об участниках) с другой платформы. Все, что что-то меняет в платформе Webex Events, является обновлением.

Команды и организации

  • Создавайте, обновляйте, читайте и удаляйте команды и членов команды

События

  • Обновляйте, клонируйте и читайте. События нельзя создавать или удалять с помощью API.

Участники

  • Создавайте, обновляйте, читайте, назначайте сеансы, назначайте группам и удаляйте информацию из социальных аккаунтов (номер телефона, учетные записи социальных сетей и т. д.). Участников нельзя удалить, но можно заблокировать.

Вопросы

  • Создавайте, обновляйте, читайте и удаляйте

Совет. В API вопросы называются «настраиваемыми полями»

Группы

  • Создавайте, обновляйте, читайте и удаляйте как эксклюзивные, так и неэксклюзивные группы

Сеансы

  • Создавайте, обновляйте, читайте и удаляйте

Местоположения

  • Создавайте, обновляйте, читайте и удаляйте

Совет. В API местоположения называются «регионами».

Фирменные приложения

  • Прочитайте названия фирменных приложений, статусы и названия назначенных событий

Приложение для мероприятий

  • Ознакомьтесь с основами, внешним видом и Web App настройками, а также сведениями о записях в видеоцентре

  • Создавайте, обновляйте, читайте и удаляйте следующие функции приложения Event App и их элементы, если применимо:

    • Повестка дня

    • спонсоры

    • Спикеры

    • экспоненты

    • Прямая трансляция

    • Участники

    • Настраиваемый список

    • Один товар

    • Веб-ссылка

    • Список веб-сайтов

    • Мой QR-код

Помните, что любые функции приложения Event, не перечисленные выше, необходимо добавлять и настраивать вручную.

Совет. В API функции называются «компонентами».

Регистрация

  • Ознакомьтесь с основными сведениями, внешним видом и настройками, включая настройки оформления заказа

  • Создавайте, читайте, обновляйте и удаляйте билеты, формы, вопросы и промокоды

  • Создавайте, читайте и обновляйте заказы

  • Отправляйте электронные письма с подтверждением заказа и билета

  • Отметьте чеки или счета-фактуры как оплаченные

  • Обновите информацию о покупателе заказа

  • Отмените и верните билеты

  • Создавайте, читайте, обновляйте, удаляйте, приостанавливайте и возобновляйте промокоды

  • Создавайте, читайте, обновляйте и удаляйте налоги

Совет. В API вопросы называются «настраиваемыми полями».

На месте

  • Прочитайте и обновите основные сведения и информацию о локальном приложении

Поиск потенциальных клиентов и отображение в реальном времени

  • Узнайте, активен ли продукт или опубликован на мероприятии

Что нужно знать

  • API нельзя использовать для создания мероприятия или активации каких-либо продуктов в рамках мероприятия, таких как приложение Event App и Onsite. Прежде чем разработчики смогут модифицировать событие с помощью API, вы должны активировать каждый продукт, который собираетесь использовать, и ввести основную необходимую информацию по каждому из них.

  • Время от времени мы будем выпускать новые версии API с улучшениями и исправлениями. Мы продолжим поддерживать старые версии достаточно долго, чтобы все могли перейти на новую версию. Мы будем отправлять по электронной почте обновления о новых версиях, предстоящих датах устаревания старых версий и официальных устаревших версиях.

  • Запросы API измеряются и ограничиваются во избежание злоупотреблений.

  • Сообщества также поддерживаются для пользователей Suite.

Была ли статья полезной?
Была ли статья полезной?