Быстрый старт. Создание разового мероприятия

Для проверки работы API можно воспользоваться любым REST-клиентом.
Самые простые бесплатные решения: ARC и POSTman.

Создание разового мероприятия

Самое популярное мероприятие — одиночный вебинар с регистрацией (необходимо указать имя, фамилию, почту) и дополнительными полями в регистрационной форме, например, “Ваше отчество” и “Откуда вы о нас узнали?”. 

1. POST /events — запрос для создания Event (шаблона будущего мероприятия).  

2. POST /events/{eventId}/sessions — запрос для создания EventSession (самого мероприятия). 

Внимание! 

Сначала создается Event, затем внутри него (обязательно) EventSession. 

Шаг 1. Создание Event 

Запрос

POST https://userapi.mts-link.ru/v3/events
Headers
x-auth-token: #{{Token}}
Content-Type: application/x-www-form-urlencoded
Body
name: 1000 тайн вселенной
accessSettings[isPasswordRequired]: 0
accessSettings[isPasswordRequired]: 0
accessSettings[isPasswordRequired]: 0
startsAt[date][year]: 2022
startsAt[date][month]: 1
startsAt[date][day]: 1
startsAt[time][hour]: 12
startsAt[time][minute]: 0
additionalFields[0][label]: Ваше отчество
additionalFields[0][type]: text
additionalFields[1][label]: Откуда вы о нас узнали?
additionalFields[1][type]: radio
additionalFields[1][values][0]: От друзей и знакомых
additionalFields[1][values][1]: От коллег и партнеров по работе
additionalFields[1][values][2]: Из социальных сетей
lectorIds[0]:1029

Ответ

201 Created
{
    "eventId": 2356695,
    "link": "https://events.webinar.ru/supportservice/2356695"
}

Пояснение

• Content-Type — формат передаваемых данных должен быть application/x-www-form-urlencoded. 

• x-auth-token  — ключ авторизации, который определяет пользователя, для которого создается это мероприятие. определяет то, для какого аккаунта на платформе выполняется действие. Посмотреть информацию о нем можно здесь

• name  — название мероприятия.

• accessSettings — доступ к мероприятиям. Включает в себя 3 параметра, каждый из них принимает одно значение: 0 - выключено, 1 - включено.

  - isPasswordRequired — доступ с паролем

  - isRegistrationRequired — доступ с регистрацией

  - isModerationRequired — доступ с залом ожидания

• (Архивный способ передачи данных) access  — тип доступа на мероприятие (4 — с регистрацией, подразумевает обязательное заполнение имени, фамилии и электронной почты). 

• additionalFields  — дополнительные поля, кроме имени, фамилии и почты, которые необходимо заполнить при регистрации на мероприятие; [0], [1] и т. д. — порядковые номера дополнительных полей; [type]:text  — текстовый формат дополнительного поля, свободный ответ; [type]:radio — предустановленные значения (выпадающий список), пользователь должен выбрать одно из значений [values][0] , [values][1] , [values][2]  и т. д. 

• description  — описание мероприятия на приветственной странице с формой регистрации. Поле не обязательно, по-умолчанию отсутствует. 

• eventId  — идентификатор созданного Event (потребуется для создания EventSession). 

• link  — общая ссылка на мероприятие, отличается от персональной тем, что не идентифицирует пользователя, перешедшего по ней так, как если бы он нашел ее в публикации в социальной сети, а не получил по почте. 

Общую ссылку на мероприятие (link из ответа на запрос создания Event) следует размещать в общедоступных местах, например, на сайте — для сбора регистраций участников. 

Шаг 2. Создание EventSession внутри этого Event

Требуется передать ID созданного на предыдущем шаге Event. 

Запрос

POST https://userapi.mts-link.ru/v3/events/2356695/sessions
Headers
x-auth-token: #{{Token}}
Content-Type: application/x-www-form-urlencoded

Ответ

201 Created
{
    "eventSessionId": 2405055,
    "link": "https://events.webinar.ru/supportservice/2361791/session/2405055"
}

Пояснение

• [date][year], [date][month], [date][day], [time][hour], [time][minute]   — массив данных, задающий год, месяц, день, час и минуту планируемого начала мероприятия. 

• link — здесь это ссылка на EventSession (не применяется для пользовательских сценариев). 

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