Ниже представлены таблицы с запросами по каждому методу API:

  1. Account — аккаунт (см. Таблица 3);
  2. App — приложение (см. Таблица 4);
  3. Attachment — вложение (см. Таблица 5);
  4. Auth — авторизация (см. Таблица 6);
  5. BankLetter — банковские письма (см. Таблица 7);
  6. BankModule — банковские модули (см. Таблица 8);
  7. Config — конфигурация приложения (см. Таблица 9);
  8. CurrencyControl — валютный контроль (см. Таблица 10);
  9. Diagnostics — диагностика (см. Таблица 11);
  10. Document — документы (см. Таблица 12);
  11. Download — загрузка (см. Таблица 13);
  12. Event — события (см. Таблица 14);
  13. Files — файлы (см. Таблица 15);
  14. Messages — сообщения (см. Таблица 16);
  15. Organization — организации (см. Таблица 17);
  16. Payment — платежные поручения (см. Таблица 18);
  17. Progress — прогресс (см. Таблица 19);
  18. Registry — реестр (см. Таблица 20);
  19. Sign — подпись (см. Таблица 21);
  20. Spd — СПД (см. Таблица 22);
  21. State — состояние (см. Таблица 23);
  22. Statement — выписки (см. Таблица 24);
  23. Svo — СВО (см. Таблица 25);
  24. UniversalFile — универсальные файлы (см. Таблица 26);
  25. User — пользователь (см. Таблица 27);

Account — аккаунт

Таблица 3

Тип запроса Запрос Описание
POST /api/account/create Создание нового счета
POST /api/account/update Обновление параметров счета
GET /api/account/delete Удаление счетов по их ID в базе данных
POST /api/account/update/sign_models Обновление модели подписания счета
GET /api/account Получение счета по его ID
GET /api/account/number Получение счета по его номеру
GET /api/account/all Получение всех счетов, доступных пользователю
GET /api/account/infos Получение списка информации о всех счетах текущего пользователя
GET /api/account/statement_request/infos Получение списка информации о счетах пользователя для запроса выписки
GET /api/available_certificates/infocrypt Запрос доступных сертификатов infocrypt
GET /api/available_certificates/cryptopro Запрос доступных сертификатов cryptopro
GET /api/account/bankletter_request/infos Получение списка информации о счетах пользователя для запроса писем
GET /api/nsdcrypto/profiles Получение криптографических профилей NSDCrypto
GET /api/nsdcrypto/head Получение “головы” для выбранного профиля NSDCrypto
POST /api/account/currency Получение списка номеров валютных счетов, доступных пользователю
GET /api/account/sberbank Отправка запроса на получение списка счетов Сбербанка

App — приложение

Таблица 4

Тип запроса Запрос Описание
GET /api/app Запрос общей информации о приложении
GET /api/version Запрос информации о версии и обновлениях
GET /api/version/update Запрос статуса обновления
POST /api/version/update Установка обновления до последней версии
GET /api/check_custom_logo Проверка на кастомный логотип
POST /api/create_custom_logo Создание кастомного логотипа

Attachment — вложение

Таблица 5

Тип запроса Запрос Описание
GET /api/attachments/sign_content/{documentId} Запрос подписи xml документа
POST /api/attachments/client_sign Обработка клиентской подписи документа

Auth — авторизация

Таблица 6

Тип запроса Запрос Описание
POST /api/authorize Вход в систему
PUT /api/authorize/{id} Вход в систему
POST /api/authorize/logout Выход пользователя из учетной записи
GET /api/windows-auth/enabled Включение доменной авторизации
POST /api/windows-auth Запрос доменной авторизации

BankLetter — банковские письма

Таблица 7

Тип запроса Запрос Описание
POST /api/letters Получение всех банковских писем
GET /api/letters/{accountNumber}/categories Получение всех банковских писем
POST /api/letters/create Создание банковского письма
GET /api/letters/client_sign/{letterId} Получение документа по id письма для подписания на клиенте
POST /api/letters/request Создание запроса писем для Сбербанка

BankModule — банковские модули

Таблица 8

Тип запроса Запрос Описание
GET /api/config/bankmodules/get Получение списка используемых модулей
POST /api/config/bankmodules/update Обновление конфигурации банковского модуля
GET /api/config/bankmodules/sberbank/certificates/{inn} Для сбербанка: запрос на получение списка сертификатов доступных для подписания
GET /api/config/bankmodules/vtb/dicts/download Для ВТБ: загрузка словарей
GET /api/config/bankmodules/vtb/dicts/state Для ВТБ: состояние загрузки словарей

Config — конфигурация приложения

Таблица 9

Тип запроса Запрос Описание
GET /api/updfreq Получение периода обновления статусов
GET /api/opday Получение операционного дня
GET /api/config/info Получение информации о конфигурации Транзит 2.0
POST /api/config/update Обновление конфигурации Транзит 2.0
GET /api/config/security Запрос информации о безопасности конфигурации
POST /api/config/security/update Обновление информации о безопасности конфигурации
GET /api/person_codes Получение списка всех кодов депонента НРД

CurrencyControl — валютный контроль

Таблица 10

Тип запроса Запрос Описание
POST /api/currency/attachment/add Добавление приложений к документу
POST /api/currency/{id}/attachments/get Получение приложений к документу

Diagnostics — диагностика

Таблица 11

Тип запроса Запрос Описание
GET /api/diag/logs Запрос списка локальных лог-файлов
POST /api/diag/logs/{id}/upload Запрос списка локальных лог-файлов

Document — документы

Таблица 12

Тип запроса Запрос Описание
GET /api/documents/{id} Получение документа
GET /api/documents Получение списка документов
GET /api/documents/{id}/content Запрос содержимого документа
GET /api/messages//links Запрос связанных документов
POST /api/archive_documents Запрос архива документов

Download — загрузка

Таблица 13

Тип запроса Запрос Описание
GET /api/download/statement/{id}/{format} Загрузка формата выписки
GET /api/svo/{id}/{format} Запрос формата СВО
GET /api/spd/{id}/{format} Запрос формата СПД
POST /api/spd/attachment/download Скачивание вложения из СПД документа
GET /api/letters/attachment Получение прикрепленного файла в письме
GET /api/payments/{id}/xml Формирование ссылки для скачивания печатной формы платежного поручения в формате .xml
GET /api/payments/{id}/pdf Формирование ссылки для скачивания печатной формы платежного поручения в формате PDF
GET /api/payments/pdfs Формирование ссылок для скачивания печатных форм платежных поручений в .xml формате
GET /api/payments/compose Формирование составной печатной формы нескольких платежных поручений
GET /api/event/file Получение файла события
GET /api/payments/sign/download Скачивание подписанных документов
POST /api/currency/attachment/download Скачивание вложения из документа валютного контроля

Event — события

Таблица 14

Тип запроса Запрос Описание
POST /api/events Получение событий, доступных пользователю

Files — файлы

Таблица 15

Тип запроса Запрос Описание
GET /api/files/dl/path Запрос пути к файлу
GET /api/files/{id} Скачивание файла
GET /api/documents/{id}/file Скачивание файла документа
GET /api/files/dl/{id} Скачивание файла

Messages — сообщения

Таблица 16

Тип запроса Запрос Описание
POST /api/messages/create/pdu Создание PDU сообщения (не используется на данный момент)
GET /api/messages/micex/{id}/content Получение содержимого документа
POST /api/messages/micex Создание документа М-Депозита
POST /api/messages/micex/update Обновление документа М-Депозита
POST /api/messages/micex/send Отправка документа М-Депозита

Organization — организации

Таблица 17

Тип запроса Запрос Описание
GET /api/organization/all Получение всех организаций
GET /api/authorize/organizations Получение списка организаций пользователя
GET /api/organization/person_codes Получение всех кодов депонента НРД
GET /api/organization/create Добавление новой организации
POST /api/organization/update Обновление существующей организации
GET /api/organization/delete Удаление организаций по их ID

Payment — платежные поручения

Таблица 18

Тип запроса Запрос Описание
POST /api/payments Получение платежных поручений
POST /api/payments/filter-data Получение списка уникальных полей для фильтрации
POST /api/files/doc1c/convert Конвертация 1С файлов в iso и сохранение в папке DRAFT. Требует наличия у пользователя “Активных” прав относительно номера счета отправляемого документа
POST /api/files/currency/convert Конвертация файлов валютных платежей. В начале названия файла должен быть указан ОГРН: ОГРН_название.json
POST /api/payments/resend Повторная отправка документов с ошибкой отправки ФШ (статус NACCEPT или TERMINAL_ERROR)
GET /api/payments/{id}/html Формирование печатной формы платежного поручения в формате HTML
POST /api/rsts/get Получние всех РСТС документов
POST /api/rsts/create Cоздание РСТС документов

Progress — прогресс

Таблица 19

Тип запроса Запрос Описание
GET /api/get_exchange_progress Получение прогресса обмена платежных поручений

Registry — реестр

Таблица 20

Тип запроса Запрос Описание
POST /api/payments/create_registry Создание реестра документов
POST /api/payments/remove_from_registry Удаление документов из реестров
GET /api/payments/{id}/registry Получение количества платежных поручений в реестре и суммы по всем платежным поручениям в реестре

Sign — подпись

Таблица 21

Тип запроса Запрос Описание
POST /api/document/sign Подпись документов одного типа
POST /api/document/sign_content Запрос шаблона подписи .xml документа
POST /api/document/client_sign Обработка клиентской подписи документа
GET /api/document/sign_text_content Запрос контента документа для подписи
POST /api/document/reject Отклонение документов
POST /api/document/delete Удаление сообщений из базы данных и папки. Требует наличия у пользователя “Активных” прав относительно номера счета удаляемого документа
POST /api/document/reset_to_draft Сброс платёжных поручений до черновика (только админ)

Spd — СПД

Таблица 22

Тип запроса Запрос Описание
POST /api/files/spd/convert Конвертация СПД файлов
POST /api/spd/get Получение документов СПД
GET /api/spd/{id}/html Формирование печатной формы СПД в HTML формате
POST /api/spd/update Обновление УФ СПД на основе данных экранной формы

State — состояние

Таблица 23

Тип запроса Запрос Описание
GET /api/state Запрос состояния сервера
PUT /api/state/start Запуск сервера
PUT /api/state/stop Остановка сервера

Statement — выписки

Таблица 24

Тип запроса Запрос Описание
POST /api/statement/list Отправка запроса на получение списка всех выписок
POST /api/statement/document_cash_managment_entries Получение всех записей по операциям выписок
POST /api/statement/cash_management_for_summary Получение всех выписок для Сводной информации
POST /api/statement/request Создание запроса выписки
POST /api/statement/delete Удаление запросов выписок (только админ)

Svo — СВО

Таблица 25

Тип запроса Запрос Описание
POST /api/svo/get Получение документов СВО
POST /api/files/svo/convert Конвертация СВО файлов
GET /api/svo/{id}/html Формирование печатной формы СВО в HTML формате

UniversalFile — универсальные файлы

Таблица 26

Тип запроса Запрос Описание
POST /api/universal_file/get Получение универсальных файлов
POST /api/universal_file/update Обновление универсальных файлов
POST /api/universal_file/config/get Получение конфигурации универсальных файлов

User — пользователь

Таблица 27

Тип запроса Запрос Описание
POST /api/user/create Создание нового пользователя
POST /api/user/update Обновление параметров существующего пользователя
POST /api/user/current/update Обновить параметры текущего пользователя
GET /api/user/delete Удаление пользователей по их ID в базе данных
GET /api/user/all Получение всех пользователей
GET /api/user Получение пользователя по его ID
GET /api/user/current Получение пользователя по его ID
GET /api/users/AD Поиск пользователей в Active Directory
POST /api/user/permissions/create Создание/перезапись полномочий пользователя
POST /api/user/permissions/update Обновление полномочий пользователя
POST /api/user/permissions/delete Удаление полномочий пользователя
GET /api/user/tablesstate Получение состояния клиентских таблиц пользователя
POST /api/user/tablesstate/update Обновление состояния клиентских таблиц пользователя