Публичное API Event Rocks: возможности, настройка и F.A.Q.

Кратко

API (Application Programming Interface) — это набор способов и методов, при помощи которых одна система может взаимодействовать с другой.

В Event Rocks используется два вида API:

Внутреннее API — обслуживает пользовательский интерфейс мобильного приложения и веб-версии платформы.
Публичное (внешнее) API — предназначено для интеграции со сторонними сервисами: CRM, регистрационными платформами, системами билетинга, базами участников. Позволяет автоматически вносить и передавать данные в Event Rocks.

Когда использовать

Публичное API подойдёт, если нужно:

выгрузить программу мероприятия из учётной системы организатора;
синхронизировать список участников и докладчиков с внешней CRM или платформой регистрации;
автоматически обновлять расписание, залы и состав спикеров;
передавать данные экспонентов выставки;
начислять или списывать баллы геймификации участникам из внешней системы;
синхронизировать «Избранное» участников (отмеченные доклады в расписании) в обе стороны.

Документация для разработчиков

Актуальная документация опубликована в Postman:

На русском языке — https://documenter.getpostman.com/view/19584337/2sA3QwdVkc
На английском языке — https://documenter.getpostman.com/view/36445713/2sA3XV7Jnq

Примеры запросов — https://documenter.getpostman.com/view/19584337/UVeNo3yX#intro. Коллекция ориентирована на ивенты; в планах — расширение под обучающие программы.

Важно для менеджеров Event Rocks: Памятка о работе с функцией External API.

Возможности публичного API

С помощью публичного API Event Rocks можно управлять следующими сущностями мероприятия (создание/изменение/удаление):

Программа мероприятия:

Залы и площадки;
Доклады, события и информационные блоки;
Теги выступлений;
Докладчики и модераторы;
Материалы и ссылки к выступлениям.

Взаимодействие с участниками:

Выгрузка вопросов, заданных к выступлениям;
Управление участниками и докладчиками;
Синхронизация изменений участников с внешней системой;
Управление группами участников;
Двухсторонняя синхронизация «Избранного» в расписании.

Выставка и геймификация:

Управление экспонентами выставки;
Ручное начисление и списание баллов геймификации.

Как настроить

Независимо от того, какие данные выгружаются из внешней системы в Event Rocks, порядок действий одинаковый:

Запросите у менеджера проекта секретный ключ авторизации для тестового события. На нём удобно настраивать и проверять выгрузку.
Получите доступ к тестовому событию в административной зоне Event Rocks, чтобы контролировать выгрузку и корректность данных.
После успешного тестирования запросите у менеджера ключ авторизации для продакшен-события.
Перенастройте систему выгрузки (подставьте боевой секретный ключ) и выполните несколько тестовых прогонов.
Когда ошибок нет — удалите тестовые данные и начните полноценную выгрузку.

Проверка настроек

Тестирование выгрузки данных проводится на тестовом событии. Для авторизации менеджер присылает:

ID события;
секретный ключ;
инструкции по API.

Проверить корректность выгрузки можно двумя способами:

Через панель администрирования: Откройте https://admin.eventicious.com/ и зарегистрируйтесь под своей учётной записью. Если регистрационное письмо не пришло — менеджер может выдать доступ на нужные e-mail адреса.
Через мобильное приложение: Установите приложение-контейнер Event.Rocks по ссылке https://store.eventicious.com/eventrocks. На экране выбора события введите ID события (секретное слово). Регистрация и авторизация свободные.

Если данные выгружаются, но не появляются в системе, отправьте менеджеру лог-файлы выгрузки с указанием часового пояса и конкретных примеров (например, ID не выгруженных участников).

Примеры использования

1. Импорт программы конференции. Внешняя система управления мероприятием (или Excel-скрипт организатора) выгружает залы, временные слоты, доклады, спикеров и теги. Участники видят актуальное расписание в мобильном приложении сразу после публикации.

2. Синхронизация участников с платформой регистрации. После оплаты билета на стороне регистратора данные участника автоматически попадают в Event Rocks — ему открывается доступ к приложению, рассылаются приглашения и пуш-уведомления.

3. Обновление состава спикеров. Замена докладчика или добавление модератора отражается в программе без ручной правки в админке.

4. Геймификация. Партнёр или спонсор начисляет участникам баллы за прохождение стенда; выставка импортирует экспонентов из CRM, а баллы списываются при обмене на призы.

5. Выгрузка вопросов спикерам. Модератор сессии получает список вопросов, заданных участниками из приложения, в удобной для обработки форме.

Ограничения и нюансы

Все изменения в сущностях, выгруженных через API, нужно делать только через API. Иначе ручные правки будут перетёрты при следующей синхронизации.
External ID присваивается на стороне выгрузки: значение произвольное, но только числовое.
Выгружайте только новую информацию, не перезаписывайте массив с нуля. Это снижает нагрузку на сервер и не сбрасывает ручные правки. Например, если участник сменил имя в приложении с «Вася» на «Василий», полная перезапись вернёт ему «Васю». Добавляйте только новые/изменённые записи.
Выгрузка списка участников из Event Rocks наружу через публичное API в настоящий момент недоступна (см. F.A.Q. ниже).
Системный профиль «Команда организатора» нельзя перетирать — от него публикуются пуш-уведомления в ленте. Поэтому инкрементальная выгрузка критически важна.

F.A.Q.

— Можно ли выгрузить список участников из вашей системы через публичное API?

Нет, в настоящее время такой возможности нет.

— Как проверить настройки, не трогая боевое событие?

Используйте тестовое событие. Менеджер пришлёт ID события, секретный ключ и доступ в админку. Дальнейшая проверка — через admin.eventicious.com или мобильное приложение Event.Rocks.

— API не работает. Что делать?

Отправьте менеджеру проекта:

описание проблемы и скриншот;
какие методы вызываются;
что отвечает система (с примером запроса/ответа, если есть).

Команда Event Rocks проверит информацию и даст ответ.

Связанные статьи

Возможности платформы Event Rocks
Интеграции со сторонними сервисами
Управление программой мероприятия
Управление участниками и группами
Геймификация в мобильном приложении
Пуш-уведомления и лента организатора