REST API и вебхуки
Всё, что доступно в кабинете, доступно по API: создание проверки, ссылка для заёмщика, загрузка файлов, проверки провайдеров, сводка и PDF. Результат приходит вебхуком, поэтому опрашивать сервис не нужно.
Тариф Все тарифы. В песочнице только тестовый API, белый список IP в Bank Pro и Enterprise.
Что внутри
- REST API с версией v1 в адресе и единым форматом ответа
- API-ключ с правами доступа или OAuth2 client credentials
- Секрет ключа создаётся на сервере и показывается один раз
- Ключ идемпотентности на создание проверки
- Вебхуки 11 типов событий с подписью HMAC-SHA256, повторами и журналом доставки
- Белый список IP-адресов организации
- Документация OpenAPI 3.1 с интерфейсом Scalar на шести языках
- SLA до 99,9% в тарифе Bank Pro
Границы
Публичные и анонимные адреса ограничены по частоте запросов. Ответ 429 означает повторить позже с паузой.
Частые вопросы
Как проверить, что вебхук пришёл от платформы?
Пересчитайте HMAC-SHA256 от метки времени и тела запроса секретом вебхука и сравните с заголовком подписи. Слишком старую метку времени отклоняйте.
Что будет, если повторить создание проверки после таймаута?
С тем же ключом идемпотентности вернётся уже созданная проверка, дубль не появится.
Сценарии с этой возможностью
Другие возможности
Покажем проверку на вашем отчёте?
Пришлите обезличенный пример отчёта из нужной страны: разберём его на демо, покажем флаги, сводку и подключение к вашей системе.