База знаний
Интеграция сервиса и API
Опубликовано Илья Финогеев on 01 April 2016 16:12

API (Application Programming Interface) в переводе с английского - интерфейс программирования приложений, представляет собой набор готовых функций и методов, с помощью которых можно создавать свои собственные программы/ приложения/ скрипты для работы с сервисом.

Работа с API осуществляется путем направления запросов на специальный URL сервиса (https://userapi.webinar.ru/v3), и получения ответов, содержащих запрошенные данные. Таким образом, API позволяет с помощью таких запросов-ответов выполнять работу с сервисом, как и через web-интерфейс.

Функционал API позволяет интегрировать сервис со своим сайтом, корпоративными системами (СРМ и т.п.), либо создать приложение для управления функционалом сервиса. Например, самый простой и распространенный вариант интеграции - создать форму регистрации на своем сайте, данные, вводимые участниками, с помощью запросов API передавать в сервис вебинаров, получать индивидуальные ссылки для участников, и самостоятельно передавать или рассылать их участникам.

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

 

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

 

Рассмотрим функционал сервиса, возможность управления которым доступна через API.

 

  1. Мероприятия

  • Возможность создавать, редактировать и удалять мероприятия, как одиночные, так и серийные.

  • Получать информацию о мероприятиях организации или конкретного участника организации. Получать информацию о конкретном мероприятии.

  • Запускать и останавливать мероприятия.

 

2. Контакты (адресная книга)

  • Создание/ обновление / удаление контактов.

  • Поиск контактов.

  • Добавление/ удаление тегов группе контактов.

 

3. Участники

  • Регистрировать участников, как на отдельное мероприятие, так и на все мероприятия серии.

  • Получать список участников мероприятия/ серии.

  • Модерировать участников.

  • Изменить роль участника (участник, ведущий, администратор).

  • Выгнать/ удалить участника.

  • Массовая регистрация до 10 000 участников.

 

4. Записи

  • Получить список записей.

  • Отправить ссылку на запись участникам мероприятия.

  • Поставить запись на конвертацию.

  • Проверить статус конвертации.

  • Удалить запись.

 

5. Чат

  • Отправлять сообщения в чат.

  • Удалять сообщения.

  • Модерировать чат.

  • Получать все сообщения чата.

 

6. Вопросы

  • Получить вопросы.

  • Отправить вопрос/ ответ.

  • Модерировать вопросы.

 

7. Файлы

  • Загружать и удалять файлы.

  • Прикреплять файл к мероприятию.

  • Разрешать доступ к файлу участникам.

 

8. Тесты

  • Создавать, обновлять, удалять тест.

  • Запускать и останавливать тест.

  • Получать результаты теста.

  • Получать статистику пользователя по тестам.

  • Отправить ответы пользователя.

 

9. Статистика

  • Получать статистику по мероприятиям.

  • Получать статистику по участникам.

  • Получать статистику по посещению пользователем мероприятий.

 

10. Получать список участников организации.


Более подробное описание функционала API всегда можно найти в личном кабинете в разделе Бизнес - API.

 

 

 

Подробная документация API доступна в документе по ссылке https://events-storage.webinar.ru/api-storage/files/webinar/system/API.pdf



Вложения