Интеграция с информационной системой

Структура данных API-интерфейса

Структура данных API-интерфейса

Для обмена данными программный интерфейс СБИС API использует формат JSON-RPC. Обмена с online.sbis.ru происходит с помощью HTTP-запросов/ответов.

  • POST — запросы на выполнение команд;
  • GET — запросы для получения содержимого указанного ресурса — данных вложений или электронных подписей (ЭП).

Заголовок запроса

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

  • адрес сервера:
  • идентификатор сессии «X-SBISSessionID»;
  • кодировка символов в поле «Content-Type»:
    • «utf-8»: application/json-rpc;charset=utf-8 — рекомендуемая кодировка;
    • либо «windows-1251»: application/json-rpc;charset=windows-1251;
  • название и версия информационной системы в заголовке «User-Agent».

Объект запроса

Объект запроса содержит:

  • значение и версия спецификации JSON-RPC — «jsonrpc»:«2.0»;
  • параметр «method» с названием команды;
  • параметр «params» с объектом параметров команды;
  • параметр «id»с целочисленным значением.

Объект ответа

В ответ на запрос с сервера возвращается JSON-структура:

  • значение и версия спецификации JSON-RPC — «jsonrpc»:«2.0»;
  • параметр «id» со значением равным значению в объекте запроса;
  • значение объекта «result», содержащее ответ на команду.

Если произошла ошибка, в ответе на запрос появится значение «error».

Объект ошибки

В случае ошибки в объекте ответа в поле «error» будут:

  • «code» — код ошибки;
  • «message» — текстовое сообщение об ошибке;
  • «details» — подробное описанием ошибки;
  • «data» — тип ошибки.

Пример POST-запроса

Пример ответа(упрощенный для наглядности)

Пример GET-запроса на получение содержимого вложения

Пример ответа

Пример ошибки