Для подключения к мероприятиям пользователей, аутентифицированных во внешних сервисах, без авторизации в ЛК EYEVOX, разработан сервис, с помощью которого можно:
2. Требования
Для получения доступа к API необходимо:
3. Описание методов
Для запросов к APIиспользуются следующие пути:
В HTTP-заголовке X-API-Key необходимо указать полученный API-key. Ключ необходимо передавать в HTTP-заголовке при каждом запросе.
В случае ошибок API вернет ошибки:
Название метода | Параметр | Тип передачи | Тип | Описание | |
getEventsList | Методполученияспискамероприятий | ||||
getEventsList | id | out | String | Номер мероприятия в ЛК | |
getEventsList | name | out | String | Название мероприятия | |
getEventsList | confType | out | String | Тип мероприятия | |
getEventsList | confStatus | out | String | Статус мероприятия | |
getEvent_Info | Метод получения информации о мероприятии | ||||
getEvent_Info | id | in | String | Номер мероприятия в ЛК | |
getEvent_Info | createDate | out | String | Дата создания записи мероприятия | |
getEvent_Info | name | out | String | Название мероприятия | |
getEvent_Info | welcome | out | String | Текст описания мероприятия | |
getEvent_Info | duration | out | String | Длительность мероприятия (в часах) | |
getEvent_Info | confType | out | String | Тип мероприятия | |
getEvent_Info | confStatus | out | String | Статус мероприятия | |
getEvent_Info | serverOnDemand | out | String | Признак выделенного или облачного сервера | |
getEvent_Info | recurrentType | out | String | Тип периодичности проведения | |
getEvent_Info | lobby | out | String | Признак лобби | |
getList | Присоединение к мероприятию | ||||
getEvent_Info | id | in | String | Номер мероприятия в ЛК | |
Список пользователей пользователей для закрытого мероиятия | |||||
postJoin | Присоединение к мероприятию | ||||
postJoin | eventId | in | String | ИД мероприятия | |
postJoin | in | String | email участника | ||
postJoin | fullName | in | String | Имя участника | |
postJoin | comment | in | String | Комментраий | |
postJoin | responses:200 | out | string |
Ссылка на мероприятие
|
|
Получение информации о мероприятии по ссылке из ЛК
|
|||||
joinUrl
|
in | string | Полученная ссылка для подключения к мероприятию | ||
{ | out | json | Информация по мероприятию: | ||
"event":{ | json | ||||
"id":"string", | json | Id – номер мероприятия | |||
"startConf":"string", | json | startConf - начало мероприятия | |||
"name":"string", | json | name – название мероприятия | |||
"duration": 0, | json | duration – продолжительность мероприятия | |||
"confType":"OPEN_FOR_ALL", | json | confType – тип мероприятия | |||
"confStatus":"CREATED", | json | confStatus – статус мероприятия | |||
"serviceTags":"string", | json | serviceTags – | |||
"notRegInput":false | json | notRegInput – разрешен ли вход незарегистрированным пользователям | |||
}, | json | ||||
"email":"string" | json | .. – Ссылка на трансляцию. | |||
} | json |
Доработаны API для интеграции с внешними сервисами – теперь при получении информации о мероприятии, получаем:
• Список участников;
• Ссылку на трансляцию.
В Личном кабинете для пользователей, связанных с внешними сервисами доступна функция проставления чекбокса «Ссылка на трансляцию», которая генерируется при создании мероприятии. Данная ссылка доступна внешнему сервису через секретный токен.
Интеграция с внешними системами доступна только в web-версии.
Интеграция с внешними системами доступна только в web-версии.
Интеграция с внешними системами доступна только в web-версии.
Интеграция с внешними системами доступна только в web-версии.