Благодарим за обратната връзка.
Обратна връзка?Ако имате разработчик във вашия екип, който знае как да използва GraphQL API, Webex Events API може да бъде вашият шлюз към мощни автоматизации за настройка и управление на събития и продукти, интеграции на платформи на трети страни, мощни табла за данни за много събития и др.
Какво може да направи API за събития на Webex
Казано по-просто, API е интерфейс за програмиране, който разработчиците могат да използват, за да получат данни от или да поставят данни в онлайн платформа - в случая Webex Events.
Възможностите на API могат да бъдат опростени до четири основни понятия:
-
Създайте нещо, което не е съществувало преди, като участник, сесия или цяло Събитие.
-
Актуализи райте всичко, за което API може да се използва за създаване, плюс още няколко неща. Например API може да се използва за създаване на нов участник и след това да редактирате името, имейла, статуса, групите, телефонните номера и социалните акаунти на този участник.
-
Прочетете информация за всичко, което API може да се използва за създаване или редактиране, плюс някои неща, които не може.
-
Из трийте всичко, за което API може да се използва за създаване, с някои изключения.
Имайте предвид тези понятия, докато четете раздела „Работа с разработчици“ на тази статия.
Как да започнете
1. Получете достъп до API
Ако сте клиент на Webex Suite Enterprise Agreement (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 ключ, автоматично се създава нов API екип в платформата Webex Events. Предоставянето на достъп на вашите разработчици да изпробват API на Webex Events е толкова просто, колкото да ги поканите в този екип на API. Следвайте инструкциите в нашата статия за управление на екипи, членове и кредити, за да научите как.
Имайте предвид, че API пясъчникът е отделна версия на платформата Webex Events, направена специално за тестване. Това означава, че всички нови членове на екипа на API Sandbox трябва да създадат нов акаунт в платформата, за да използват пясъчника, дори ако вече имат акаунт в платформата или влязат в SSO на организацията си.
Хората във вашия API екип нямат достъп до останалата част от платформата Webex Events по начина, по който го правят организаторите. Вместо това членовете на екипа на API имат достъп до API „пясъчник“, където могат да тестват това, което изграждат, без да засягат реалните данни. Ако искате разработчиците да имат достъп и до някои или всички ваши реални събития и приложения в платформата Webex Events, поканете ги в съответните екипи, които не са API.
4. Бъдете мили към разработчиците си
Това е от решаващо значение, затова направихме цяла стъпка. 😉
„Рим не е построен за един ден“, както и добра интеграция на API. Бъдете добър приятел на вашите разработчици и им дайте достатъчно време, за да се запознаят с API на Webex Events, преди да очаквате от тях да предоставят интеграции. Те ще бъдат благодарни, че не бъдат подложени на натиск.
Като минимум препоръчваме да започнете разговори с вашите разработчици не по-малко от шест месеца, преди да имате нужда от интеграции. Продължете да четете, за да научите как да се подготвите и да водите тези разговори.
Работа с разработчици
След като поканите разработчици във вашия екип на Webex Events Sandbox, един от първите ви въпроси може да бъде: „Колко време ще отнеме изграждането на интеграции?“ Отговорът на този въпрос зависи от много фактори, включително от колко разработчици работите, колко време имат за работа върху интеграциите, колко сложни са интеграциите и др.
Само вашите разработчици могат да ви кажат колко време ще отнеме настройката на интегра цията и само след няколко важни стъпки:
-
Първо прочетете разделите по-долу, за да научите какво може да направи API. Това ще ви помогне да разберете какво е възможно, за да можете ясно да съобщите нуждите си с вашите разработчици.
-
Запознайте се с вашите разработчици, споделете нашата API документация с тях и обсъдете какво искате. Те ще могат да дадат основна обратна връзка за това какво могат и какво не могат да направят за вас. Те обаче няма да могат да ви дадат конкретни срокове, докато не са запознати с API на Webex Events.
-
Дайте време на разработчиците си да се запознаят с API. Останете на разположение, за да отговорите на концептуални или практически въпроси относно вашите събития, данни, платформата Webex Events и всичко друго.
Какво може да направи API
API има две основни функции:
-
Прочетете - Вземете данни от Webex Events, за да можете да ги разгледате или да ги изтеглите в друга система.
-
Актуализа ция - Поставете данни в Webex Events, за да създавате нови елементи или да синхронизирате данни, като например участници, от друга платформа. Всичко, което променя нещо в платформата Webex Events, е актуализация.
Екипи и организации
-
Създаване, актуализиране, четене и изтриване на екипи и членове на екипа
Събития
-
Актуализирайте, клонирайте и четете. Събитията не могат да бъдат създадени или изтрити с API.
Участници
-
Създавайте, актуализирайте, четете, присвоявайте към сесии, присвоявайте към групи и изтривайте информация за социалните акаунти (телефонен номер, обработки за социални акаунти и т.н.). Участниците не могат да бъдат изтрити, въпреки че могат да бъдат блокирани.
Въпроси
-
Създаване, актуализиране, четене и изтриване
Съвет: В API въпросите се наричат „персонализирани полета“
Групи
-
Създаване, актуализиране, четене и изтриване на изключителни и неизключителни групи
Сесии
-
Създаване, актуализиране, четене и изтриване
Местоположения
-
Създаване, актуализиране, четене и изтриване
Съвет: В API местоположенията се наричат „региони“.
Брандирани приложения
-
Прочетете имена на брандирани приложения, статуси и имената на зададени събития
Приложение за събития
-
Прочетете основите, външния вид и Web App настройките плюс информация за записи на видео центъра
-
Създавайте, актуализирайте, прочетете и изтривайте следните функции на приложението за събития и техните елементи, където е приложимо:
-
Дневна програма
-
Спонсори
-
Високоговорители
-
Изложители
-
Излъчване на живо
-
Участници
-
Персонализиран списък
-
Единичен артикул
-
Уеб линк
-
Уеб списък
-
Моят QR код
-
Имайте предвид, че трябва ръчно да добавяте и конфигурирате всички функции на приложението за събития, които не са изброени по-горе.
Съвет: В API функциите се наричат „компоненти“.
Регистрация
-
Прочетете информацията за основите, външния вид и настройките, включително настройките за плащане
-
Създавайте, четете, актуализирайте и изтривайте билети, формуляри, въпроси, промо кодове
-
Създаване, четене и актуализиране на поръчки
-
Изпращане на имейли за потвърждение на поръчки и билети
-
Маркирайте поръчките за чек или фактуриране като платени
-
Актуализирайте информацията за купувача на поръчката
-
Отмяна и възстановяване на билети
-
Създаване, четене, актуализиране, изтриване, пауза и възобновяване на промо кодове
-
Създаване, четене, актуализиране и изтриване на данъци
Съвет: В API въпросите се наричат „персонализирани полета“.
На място
-
Прочетете и актуализирайте основите и информацията за приложението на място
Извличане на потенциални клиенти и показване на живо
-
Прочетете дали продуктът е активен или публикуван в събитието
Неща, които трябва да знаете
-
API не може да се използва за създаване на събитие или активиране на някой от продуктите в събитие, като например приложението за събития и Onsite. Преди разработчиците да могат да променят Събитие с API, трябва да активирате всеки продукт, който възнамерявате да използвате, и да попълните основната необходима информация за всеки от тях.
-
Понякога ще пускаме нови версии на API с подобрения и поправки. Ще продължим да поддържаме старите версии достатъчно дълго, за да могат всички да преминат към новата версия. Ще изпращаме актуализации по имейл за нови версии, предстоящи дати на отпадане на старите версии и официални прекратявания.
-
API заявките са измервани и ограничени, за да се предотврати злоупотреба.
-
Общностите също се поддържат за клиенти на Suite.
