Программный сервис взаимодействия (API)

API предназначен для взимодействия BlackTerminal.ru с другими web-сайтами и приложениями. С помощью API можно получить информацию, имеющуюся в базе данных BlackTerminal.ru.

API находится по адресу: https://blackterminal.ru/api/0.0.5

Все запросы производятся путем отправки данных в формате POST.
Ответы сервера приходят в формате JSON в кодировке utf8.
Для работы с API требуется ключ приложения. Получить ключ можно направив запрос на адрес электронной почты support@blackterminal.ru

Ниже приведен перечень информации, которую можно получить при помощи API


Аутентификация пользователя (запрос хэша)

Отправить POST-запрос с параметрами ("login", "email", "password", "key").
Параметры "email", "password", "key" должны быть не пустыми.
Параметр "login" - флаг (может быть пустым)
Варианты ответа:
Юзер вошел <hash>.
Неверный пароль - "pass_incorrect"
Пользователь неизвестен - "user_unknown"
Пользователь не активировал почту - "email_inactive"

Полученный хэш хранится месяц. Приложение должно запомнить хэш пользователя и не запрашивать новый хэш до тех пор, пока при очередном запросе от сервера не придет ответ <hash_invalid>

Получение информации о пользователе

Отправить POST-запрос с параметрами ("hash", "getuserinfo", "key"), где:
hash - полученный при аутентификации пользователя или сохраненный в приложении хэш
getuserinfo - флаг (может быть пустым)
варианты ответа:
Успех - <user> - json-кодированная информация о пользователе
Хэш не найден - "hash_invalid"

Получение списка эмитентов

Отправить POST-запрос с параметрами ("getemlist", "key"), где:
getemlist - флаг (может быть пустым)
варианты ответа:
Успех - <emitters_list> - json-кодированная информация об эмитентах

Получение списка акций

Отправить POST-запрос с параметрами ("getsharelist", "key"), где:
getsharelist - флаг (может быть пустым)
варианты ответа:
Успех - <shares_list> - json-кодированная строка со спиком акций

Получение информации об эмитенте

Отправить POST-запрос с параметрами ("getemitent", "eid", "key"), где:
getemitent - флаг (может быть пустым)
eid - emitent id (id эмитента)
варианты ответа:
Успех - <emitent> - json-кодированная информация об эмитенте
Эмитент не найден - "emitent_not_found"

Получение информации об акции

Отправить POST-запрос с параметрами ("getshare", "id", "key"), где:
getshare - флаг (может быть пустым)
id - код акции (например, GAZP)
варианты ответа:
Успех - <share> - json-кодированная информация об акции
Акция не найдена - "share_not_found"

Получение списка новостей

Отправить POST-запрос с параметрами ("getnewsfeed", "key"), где:
getnewsfeed - флаг (может быть пустым)
варианты ответа:
объект { "last_id":"id последней новости","news_array":[] }

Использование параметров "offset", "id"
Параметр "offset" служит для указания направления "листания" списка новостей, может принимать значения "before" и "after" чтобы получать более "старые" и "новые" новости соответственно. Используется совместно с параметром "id" (id новости) который указывает, относительно какой новости двигаться по списку во время "листания".

Параметр "count" (опциональный) указывает, сколько новостей выводить в массиве news_array. Может принимать значения от 0 до 100. Значение по умолчанию - 10.


changelog
API 0.0.5 в запросах getemlist, getsharelist, getemitent, getshare теперь выдаются эмитенты и акции США.