API и события платформы

Всё, что делает сотрудник в интерфейсе, доступно через API. Партнёрские каналы, сайт заёмщика и внутренние сервисы работают с теми же контрактами.

Доступ и заголовки

Запрос адресуется конкретной организации и конкретной локали. Ключ выдаётся с областями доступа, перевыпускается без остановки работы и может быть отозван.

Документация API

Organization-Id: Определяет организацию. В режиме отдельной базы на арендатора по нему выбирается подключение.
Language-Code: Локаль ответа: справочники, названия статусов и тексты документов возвращаются на этом языке.
X-Api-Key: Ключ партнёрской интеграции. Область доступа ограничивает набор доступных методов.
Idempotency-Key: Ключ повтора для операций с деньгами: повторная отправка не создаёт вторую транзакцию.

Разделы API

Методы сгруппированы по предметным областям и повторяют структуру платформы.

Заявки

Создание заявки, шаги проверок, документы и решения андеррайтинга.

/applications

Клиенты

Профиль, идентификаторы, документы, согласия и банковские реквизиты.

/customers

Договоры

График платежей, начисления, платежи и разнесение по компонентам долга.

/loans

Скоринг

Модели, правила, признаки и результаты с перечнем повлиявших факторов.

/scoring

Комплаенс и AML

Проверки по реестрам, алерты, профили риска и сообщения регулятору.

/compliance, /aml

Взыскание

Дела, контакты, обещания платить, судебная работа и партии цессии.

/collection

Фондирование

Инвесторы, договоры привлечения, облигационные серии и выплаты.

/funding

Отчётность

Шаблоны форм, черновики, проверка и выгрузка в нужном формате.

/reporting, /tax-reporting

Кабинет клиента

Публичные методы для сайта и приложения заёмщика.

/public/customer

События и вебхуки

Изменения по договору публикуются наружу через исходящую очередь. Доставка гарантируется повторами по нарастающему интервалу, а недоставленные сообщения попадают в отдельную очередь и не теряются.

Подписка на события
Адрес назначения, набор событий и секрет подписи настраиваются для организации.
Журнал доставок
По каждой попытке видно код ответа, тело и время следующего повтора.
События для бюро
Тридцать три типа событий договора и кредитной линии уходят в кредитные бюро.
События для бухгалтерии
Тридцать три типа событий уходят в учётную систему по HTTP или файловым обменом.

Среда и ограничения

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

Все обращения к внешним сервисам пишутся в журнал вместе с телом запроса и ответа, а ключи API хранятся только в виде хеша.

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

GET /Applications/GetApplications?Offset=0&Count=20
Organization-Id: 42
Language-Code: ru
X-Api-Key: ••••••••

Документация API Материалы и инструкции

Формат ответа: JSON с единой оболочкой: код, признак успеха, текст ошибки и полезная нагрузка.
Постраничная выборка: Серверная. Смещение и количество передаются в запросе, ответ содержит общее число записей.
Идемпотентность: Обязательна для операций с деньгами и изменений графика.
Локализация: Шесть языков. Локаль определяется заголовком запроса, а не настройкой организации.
Стенд: Отдельный контур с теми же контрактами и заглушками вместо провайдеров.
Версионирование: Несовместимые изменения выходят отдельной версией, старая продолжает работать по договору сопровождения.

Частые вопросы

Можно ли работать только через API, без интерфейса

Да. Интерфейс сотрудника использует то же API, поэтому сценарий, доступный в интерфейсе, доступен и внешнему клиенту в пределах области доступа ключа.

Как устроена аутентификация партнёра

Партнёр получает ключ с ограниченной областью доступа. Ключ хранится в виде хеша, перевыпускается без простоя, а все вызовы попадают в журнал внешних обращений с телом запроса и ответа.

Что произойдёт при повторной отправке платежа

Операции с деньгами принимают ключ повтора. Повторный запрос с тем же ключом возвращает результат первой операции и не создаёт вторую транзакцию.

Как получить уведомление о просрочке или погашении

Через подписку на события. Указывается адрес назначения, набор событий и секрет подписи. Каждая попытка доставки фиксируется, неуспешные повторяются по нарастающему интервалу.