API Голосований

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

Скачать документацию:VoteAPI.doc

Принцип аутентификации и авторизации
Создание голосования
Создание вложенных опросов
Результаты голосования
Коды ошибок для всех функций

Принцип аутентификации и авторизации

Пользователь определяется RunSMS с помощью логина (login) и пароля (password) аккаунта зарегистрированного в сервисе. Сессия соединения не устанавливается, login и password нужно передавать при каждом запросе к сервису. Запрос к API представляет собой атомарный HTTP POST запрос, возможно отправляемый по защищенному соединению (SSL).

Создание голосования

REQUEST

HTTP POST http://runsms.ru/voteapi/

Params:

login = логин пользователя в http://runsms.ru

password = пароль пользователя в http://runsms.ru

protocol = '1.0'

func = 'create'

body = '<vote

name=’Языки программирования’ // имя голосования

desc=’Какие языки Вы предпочитаете?’ // описание голосования

view_and_vote=’1’ // 1 – Разрешить видеть опрос и голосовать пользователям сайта, в противном - 0

view_result=’1’ // 1 – Разрешить пользователям сайта просматривать результаты голосования, в противном - 0

view_result_vote=’0’ // 1 – Просмотр результатов голосования, только если пользователь сам проголосует, в противном – 0

view_result_finish=’0’ // 1 – Просмотр результатов голосования, только если пользователь сам проголосует, в противном - 0

count_vote=’0’ // 1 – Разрешить голосовать несколько раз с одного телефона, в противном - 0

vote_payment=’0’ // 1 – Установить стоимость голосования для пользователей сайта, в противном – 0

vote_cost=’0’ // Cтоимость голосования для пользователей сайта, в интервале от 0.1 до 2000 руб.

date_start=’2009-12-12’ // дата начала голосования, поддерживается также unix timestamp

time_start=’12:51’ // время начала голосования

date_finish=’2010-12-12’ // дата окончания голосования, поддерживается также unix timestamp

time_finish=’19:01’ // время окончания голосования

/>

RESPONSE

<response

success='1'

vote_main_id=’3478’ // идентификатор созданного голосования

/>

Возможные коды ошибок:

101 – Данное имя голосования уже существует

102 – Неверно заполнены обязательные поля

103 – Не заполнены обязательные поля

Создание вложенных опросов

REQUEST

HTTP POST http://runsms.ru/voteapi/

Params:

login = логин пользователя в http://runsms.ru

password = пароль пользователя в http://runsms.ru

protocol = '1.0'

func = 'add'

body = '<vote

vote_main_id=’3478’ // id голосования

owner_item_id=’78’ // id элемента, если указан, то будет создан вложенный опрос

name = ‘Разновидности Языков’ //название опроса

type = ‘1’ //0,1,2,3

desc = ‘fsdfsd’ //описание опроса

required = ’0’ // 1 – обязательный, 0 – не обязательный опрос

>

…

<item val = ‘val1’/>

…

</vote>

RESPONSE

<response

success='1'

owner_item_id = ’3478’ //id элемента к которому добавлен опрос

vote_id=’345’ // id опроса

…

item_id=’1’

…

/>

Возможные коды ошибок:

201 – Несуществующее голосование

202 – Нельзя создавать опросы

203 – Не заполнены обязательные поля

204 – Несуществующий элемент опроса

205 – Неверно заполнены обязательные поля

Результаты голосования

REQUEST

HTTP POST http://runsms.ru/voteapi/

Params:

login = логин пользователя в http://runsms.ru

password = пароль пользователя в http://runsms.ru

protocol = '1.0'

func = 'result'

body = '<result

vote_main_id=’3478’ // id голосования

/>

RESPONSE

<response

success='1'

<vote id=’1’ name=’web’ count=’100’>

<item id=’1’ name=’c++’ count=’100’/>

<item id=’2’ name=’java’ count’10’/>

…

<item id=’100’ name=’php’ count’1000’/>

…

</vote>

Возможные коды ошибок:

301 – Не заполнены обязательные поля

302 – Несуществующее голосование

Коды ошибок для всех функций

Возможные коды ошибок:

401 – Ошибка аутентификации

402 – Недопустимый формат сообщения

403 – Неизвестная ошибка