API-интерфейс сервиса «Торги» использует формат JSON для обмена данными с сервером online.sbis.ru посредством HTTPS-запросов/ответов. Используемая кодировка — UTF-8, метод — POST.
Заголовок запроса
В заголовке передаваемого запроса обязательно указывается:
- адрес сервера для аутентификации — https://online.sbis.ru/auth/service/; для работы с методами API — https://online.sbis.ru/tender-api/service/;
- доменное имя сервера — Host: online.sbis.ru
- идентификатор сессии — Cookie: sid=00520de2-00671d93-0bba-63a4b4dacb2e4a86
- кодировка символов — Content-Type: application/json; charset=utf-8
Адрес сервера аутентификации и сервера для работы с методами API требуется вынести в настройки интеграционного приложения. Это значение может быть изменено.
Объект запроса
Объект запроса должен содержать:
значение "jsonrpc":"2.0", указывающее на версию спецификации JSON-RPC;
параметр "method" с названием команды;
параметр "params" с объектом передаваемых параметров команды;
параметр "id" со строковым значением.
Объект ответа
В ответ на запрос с сервера возвращается аналогичная JSON-структура:
- значение "jsonrpc":"2.0", указывающее на версию спецификации JSON-RPC;
- параметр "id" со строковым значением, аналогично объекту запроса;
- значение объекта "result", где упаковывается ответ на команду.
Если произошла ошибка, в ответе на запрос должно появиться значение "error".
Пример запроса
Рассмотрим пример запроса статистики по размеру и использованию лимита торгов за сутки.