Тази статия е преведена от английски чрез машинен превод.
Ако имате разработчик в екипа си, който знае как да използва GraphQL API, Webex Events API може да бъде вашият портал към мощни автоматизации за настройка и управление на събития и продукти, интеграции на платформи на трети страни, мощни табла за управление на данни за множество събития и други .
Какво може да направи Webex Events API
Казано по-просто, API е интерфейс за програмиране, който разработчиците могат да използват, за да получават данни от или да поставят данни в онлайн платформа – в този случай, Webex Events.
Възможностите на API могат да бъдат опростени до четири основни концепции:
Създайте нещо, което не е съществувало преди, като участник, сесия или цяло събитие.
Актуализирайте всичко, което API може да се използва за създаване, плюс още няколко неща. Например API може да се използва за създаване на нов участник и след това да редактирате името, имейла, статуса, групите, телефонните номера и социалните акаунти на този участник.
Прочетете информация за всичко, което API може да се използва за създаване или редактиране, плюс някои неща, които не може.
Изтрийте всичко, което API може да се използва за създаване, с някои изключения.
Имайте предвид тези концепции, докато четете раздела „Работа с разработчици“ на тази статия.
Как да започнете
1. Получете достъп до API
Ако сте клиент на Webex Suite Enterprise Agreement (Suite EA), който вече е активирал Webex Events , вие автоматично получавате достъп до Webex Events API! За всички останали клиенти говорете с вашия контакт за Webex Events или с нашия екип за поддръжка, за да научите за достъпа до API.
2. Създайте API ключ
Сега трябва да създадете нов API ключ, който вашите разработчици да използват. Когато имате достъп до API, се добавя нов раздел към страницата „Настройки на организацията“ в платформата Webex Events . Ето как да получите достъп до новия раздел и да създадете първия си ключ:
💡 Имайте предвид, че само администратори на организации имат достъп до страницата с API.
От всяко място в платформата Webex Events щракнете върху изображението на вашия профил в горния десен ъгъл на екрана, след което изберете Настройки на организацията от падащото меню.
На страницата с настройки на организация щракнете върху раздела API в лявото меню. Това ви отвежда до таблото за управление на API, където можете да прегледате използването на API, да експортирате регистрационни файлове за използване, да управлявате ключове и да получите достъп до нашата документация за API.
Щракнете върху Създаване на ключ .
В модала „Създаване на нов ключ“ въведете етикет за API ключа, който обяснява за какво ще се използва.
В падащото меню с версия на API вече ще е избрана текущата версия, така че просто щракнете върху Запазване . Това разкрива API ключа.
Щракнете върху бутона Копиране до ключа и поставете ключа в защитен документ, за да сте сигурни, че никога няма да бъде изгубен.
⚠️ ВНИМАНИЕ! Това е единственият път, когато може да бъде достъпен пълният API ключ. След като затворите модала, пълният ключ не може да бъде прочетен отново.
След като копирате и запазите ключа, щракнете върху бутона Затвори .
В повечето случаи се нуждаете само от един API ключ. Въпреки това, в ситуации, в които работите с множество екипи, може да искате да създадете ключ за всеки екип. Говорете с вашите разработчици за вашите конкретни случаи на употреба, за да разберете най-доброто решение.
3. Поканете разработчици за достъп до API
Когато създадете своя първи API ключ, нов API екип се създава автоматично в платформата Webex Events . Предоставянето на достъп на вашите разработчици да изпробват Webex Events API е толкова просто, колкото да ги поканите в този API екип. Следвайте инструкциите в нашата статия за управление на екипи, членове и кредити, за да научите как.
💡 Имайте предвид, че API sandbox е отделна версия на платформата Webex Events , създадена специално за тестване. Това означава, че всички нови членове на екипа на API Sandbox трябва да създадат нов акаунт в платформата, за да използват пясъчника, дори ако вече имат акаунт в платформа или влизат със SSO на своята организация.
Хората от вашия 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.