Дякуємо за відгук.
Надіслати відгук?Якщо у вашій команді є розробник, який знає, як використовувати API GraphQL, API подій Webex може стати вашим шлюзом до потужних автоматизацій та керування подіями та продуктами, інтеграції сторонніх платформ, потужних інформаційних панелей даних для кількох подій тощо.
Що може зробити API подій Webex
Простіше кажучи, API - це інтерфейс програмування, який розробники можуть використовувати для отримання даних або розміщення даних на онлайн-платформі - в даному випадку Webex Events.
Можливості API можна спростити до чотирьох основних концепцій:
-
Створіть щось, чого раніше не існувало, наприклад, учасника, сеанс або цілу подію.
-
Онов іть все, що можна використовувати для створення API, а також ще кілька речей. Наприклад, API можна використовувати для створення нового учасника, а потім редагування імені, електронної пошти, статусу, груп, номерів телефонів та облікових записів у соціальних мережах учасника.
-
Прочитайте інформацію про все, що API можна використовувати для створення або редагування, а також деякі речі, які він не може використовувати.
-
Вид аліть все, що можна використовувати для створення API, за деякими винятками.
Пам'ятайте про ці поняття, читаючи розділ «Робота з розробниками» цієї статті.
Як розпочати роботу
1. Отримати доступ до API
Якщо ви є клієнтом Webex Suite корпоративної угоди (Suite EA), у якого вже активовано Webex Events, ви автоматично отримуєте доступ до API подій Webex! Для всіх інших клієнтів зверніться до свого контакту з 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.
-
Дайте розробникам час ознайомитися з API. Будьте доступні для відповіді на концептуальні чи практичні запитання щодо ваших подій, даних, платформи Webex Events та будь-чого іншого.
Що може зробити API
API має дві основні функції:
-
Читати - Отримати дані з Webex Events, щоб ви могли їх вивчити або витягнути в іншу систему.
-
Онов лення - Розміщуйте дані в події Webex для створення нових елементів або синхронізації даних, наприклад учасників, з іншої платформи. Все, що щось змінює на платформі Webex Events, є оновленням.
Команди та організації
-
Створення, оновлення, читання та видалення команд та членів команди
Події
-
Оновлення, клонування та читання. Події не можна створювати або видаляти за допомогою API.
Учасники
-
Створювати, оновлювати, читати, призначати сеанси, призначати групам та видаляти інформацію облікового запису соціальних мереж (номер телефону, адреси соціальних облікових записів тощо). Учасників не можна видалити, хоча їх можна заблокувати.
Питання
-
Створення, оновлення, читання та видалення
Порада: У API питання називаються «користувальницькими полями»
Групи
-
Створюйте, оновлюйте, читайте та видаляйте як ексклюзивні, так і неексклюзивні групи
Сеанси
-
Створення, оновлення, читання та видалення
Місцезнаходження
-
Створення, оновлення, читання та видалення
Порада: У API локації називаються «регіонами».
Фірмові додатки
-
Читати назви фірмових додатків, статуси та назви призначених подій
Додаток для подій
-
Прочитайте відомості про основи, зовнішній вигляд та Web App налаштування, а також відомості про записи відеоцентру
-
Створюйте, оновлюйте, читайте та видаляйте наступні функції програми для подій та їх елементи, якщо це можливо:
-
Порядок денний
-
Спонсори
-
Спікери
-
Експоненти
-
Пряма трансляція
-
Учасники
-
Користувальницький список
-
Одиночний елемент
-
Веб-посилання
-
Веб-список
-
Мій QR-код
-
Майте на увазі, що ви повинні вручну додавати та налаштовувати будь-які функції програми для подій, не перераховані вище.
Порада: В API функції називаються «компонентами».
Реєстрація
-
Прочитайте інформацію «Основи», «Зовнішній вигляд» та «Параметри», зокрема налаштування оформлення замовлення
-
Створюйте, читайте, оновлюйте та видаляйте квитки, форми, запитання, промокоди
-
Створення, читання та оновлення замовлень
-
Надсилайте електронні листи з підтвердженням замовлення та
-
Позначте чекові замовлення або рахунки-фактури як оплачені
-
Оновити інформацію про покупця замовлення
-
Скасування та повернення квитків
-
Створюйте, читайте, оновлюйте, видаляйте, призупиняйте та відновлюйте промокоди
-
Створення, читання, оновлення та видалення податків
Порада: В API питання називаються «користувальницькими полями».
На місці
-
Читайте та оновлюйте Основи та інформацію про програму на місці
Пошук лідів та відображення в прямому ефірі
-
Прочитайте, чи активний продукт чи опублікований у Заході
Що потрібно знати
-
API не можна використовувати для створення Події або активації будь-яких продуктів у Події, таких як додаток для події та Onsite. Перш ніж розробники зможуть змінити подію за допомогою API, ви повинні активувати кожен продукт, який ви збираєтеся використовувати, і заповнити основну необхідну інформацію для кожного з них.
-
Час від часу ми будемо випускати нові версії API з удосконаленнями та виправленнями. Ми продовжуватимемо підтримувати старі версії достатньо довго, щоб усі могли перейти на нову версію. Ми надсилатимемо електронною поштою оновлення щодо нових версій, майбутніх дат припинення старих версій та офіційних застарілих версій.
-
Запити API вимірюються та обмежуються, щоб запобігти зловживанню.
-
Спільноти також підтримуються для клієнтів Suite.
