Simpoll API: Руководство разработчика

1.1. Введение

Simpoll API позволяет Вашему сайту взаимодействовать с любым опросом Simpoll несколькими способами. Главная задача которую решает Simpoll API — это передача результатов опроса Вашему сайту, чтобы Вы могли обработать их на своей стороне.

Simpoll API может использоваться для:

  • Сопоставления респондентов Simpoll и пользователей Вашего сайта;
  • Получения уведомлений о том, что пользователь Вашего сайта прошел опрос;
  • Получения уведомлений о том, насколько успешно пользователь Вашего сайта прошел опрос (например, сдан ли тест);
  • Получения списка ответов, которые пользователь Вашего сайта дал в опросе Simpoll;

1.2. Схема работы

В общих чертах схема работы Simpoll API сводится к следующим шагам:

  1. При вставке опроса на сайт Вы можете передать ему любые дополнительные параметры (например, ID пользователя);
  2. Пользователь проходит опрос во фрейме Simpoll;
  3. После завершения опроса Simpoll вызывает указанный URL (Result URL) на Вашем сайте, передавая ему обратно те параметры, что поступили от Вас (если они были);
  4. Помимо Ваших параметров, Simpoll передает на Result URL результаты опроса.

Таким образом, помимо уведомления Вас о результатах, опрос Simpoll может выполнять роль «прокси» для любых Ваших данных.

Передача параметров на Result URL может осуществляться одним из трех способов:

Метод POST

Передача происходит в фоне, незаметно для пользователя и без использования его браузера. Запрос отправляется в тот момент, когда пользователь нажимает кнопку «Отправить» на последней странице опроса.

Метод GET

Передача происходит путем редиректа браузера пользователя на Result URL, с добавлением GET-параметров в URL. Редирект выполняется с последней страницы опроса. При этом настройка «После завершения опроса открывать страницу» в свойствах опроса игнорируется.

Вызов callback-функции Javascript на Вашей странице

В этом случае передача Ваших параметров и результатов опроса осуществляется путем вызова Javascript-функции на той странице, в которую встроен опрос Simpoll. Функция имеет четко заданное имя и один аргумент — объект, в свойствах которого содержатся Ваши параметры и результаты опроса.

Данный способ имеет технические ограничения, т.к. кроссдоменная передача данных между фреймом и Вашей страницей не будет работать в браузерах Internet Explorer ниже 8-й версии и некоторых мобильных браузерах.

1.3. Безопасность передачи данных

Simpoll API поддерживает использование контрольной подписи для получаемых и передаваемых данных. Использование подписи не обязательно, но позволяет гарантировать что данные не будут изменены посторонним лицом в процессе передачи.