Modulbank API

Часто задаваемые вопросы

Что можно делать с помощью API?

Получать список счетов компании в Модульбанке (включая реквизиты и остаток средств)
Получать информацию по проведенным операциям по счету
Получать уведомления о произошедших транзакциях (веб-хуки)
Загружать платежки в формате 1С в ЛК
Разрабатывать в режиме “песочницы” на тестовых данных

Как получить доступ к API?

Для получения данных от API необходимо получить токен авторизации. Сделать это можно двумя способами:

Первый способ. Сгенерировать токен в ЛК Модульбанка

Для запуска процесса генерации выберите пункт "Подключиться к API" в меню действий ЛК и следуйте дальнейшим инструкциям. Генерация токена в ЛК

Важно! Полученный токен привязан к вашей учетной записи в ЛК и не должен передаваться третьим лицам!

Второй способ. Получить токен через сервер авторизации Модульбанка (протокол OAuth 2)

Если вы разрабатываете приложение (бот для телеграма, плагин для общедоступной CRM и т.д.), которое может быть полезно для любого пользователя Модульбанка, вы можете авторизовывать пользователей через сервер авторизации Модульбанка по OAuth подобному протоколу. В процессе авторизации пользователь выдаcт вашему приложению права на получение данных по его учетной записи, после чего вы получите токен, привязанный к его учетной записи.

Важно! Если вы хотите авторизовывать пользователей Модульбанка по протоколу OAuth, ваше приложение должно быть зарегистрировано у нас. Для регистрации приложения напишите нам письмо на api@modulbank.ru

Подробнее о схеме авторизации через протокол OAuth вы можете почитать в разделе Авторизация и аутентификация.

Как вести разработку, если у меня нет учетной записи в Модульбанке?

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

Что такое режим песочница и как его активировать?

Песочница - это созданный для разработки режим работы API, при котором все реальные данные о пользователях, компаниях, счетах и транзакциях подменяются на тестовые. С помощью песочницы вы можете разрабатывать и отлаживать свой код не имея учетной записи и открытого расчетного счета в Модульбанке. Для того чтобы наше API распознало входящий запрос как запрос к песочнице, нужно ясно указать это в запросе одним из двух способов: добавить в HTTP заголовок запроса (http request header) sandbox:on или добавить в URI GET параметр sandbox=on.

Пример запроса списка операций по счету в режиме песочница (параметр sandbox передан в заголовке запроса):

POST /v1/operation-history/843eeb4e-d50f-4ac7-8efd-a5ec037179a0 HTTP/1.1
Host: api.modulbank.ru
sandbox: on
Content-Type: application/json
Authorization: Bearer sandboxtoken

{
    category: 'Debit',
    skip: 50,
    records: 10
}

Тот же самый запрос, но параметр sandbox передан в URI в виде GET параметра:

POST /v1/operation-history/843eeb4e-d50f-4ac7-8efd-a5ec037179a0?sandbox=on HTTP/1.1
Host: api.modulbank.ru
Content-Type: application/json
Authorization: Bearer sandboxtoken

{
    category: 'Debit',
    skip: 50,
    records: 10,
}

Также следует помнить, что в режиме песочницы запрещено использовать реальные данные - идентификаторы приложений, токены авторизации и т.д. Вместо реальных идентификаторов в песочнице разрешается использовать следующие:

Поле	Значение	Описание
clientId	sandboxapp	Идентификатор приложения
clientSecret	sandboxappsecret	Секретное слово приложения
token	sandboxtoken	Токен авторизации