Вебхук – это механизм информирования при наступлении в системе события, на которое подписан партнёр API.
Вебхуки повышают эффективность рабочих процессов. Для получения новой информации достаточно будет создать вебхук, и Банк сам будет отправлять информацию по изменениям состояния системы.
Используется токен доступа, полученный по Authorization Code Flow для партнёрских сервисов или по Authorization Code Flow H2H для прямой интеграции.
Инструкция по подключению
- 1.Отправить письмо на почту alfa_api@alfabank.ru с указанием
callbackUriи события, на которое хотите подписаться. - 2.Далее Партнёру API на своей стороне необходимо реализовать открытый Партнёрский метод для получения вебхуков.
- 3.Подписаться на событие с помощью метода «Создание вебхука».
- 4.Использовать методы по управлению вебхуками:
- •
- •
- •
- •
Инструкция по тестированию в песочнице в статье Тестирование вебхуков.
Требования к полю callbackUri
В поле callbackUri необходимо указывать хост, который указывали в качестве redirect_uri при интеграции с Alfa ID. Проверка будет проводиться только на соответствие домена второго уровня.
Это позволяет расширить возможные варианты для callbackUri . Например, если в качестве redirect_uri был указан https://partner.ru, то можно создать следующие callbackUri :
- •
- •
- •
- •
Для создания вебхука с другим хостом необходимо удалить уже существующий вебхук.
Допустимые значения scope
| Событие | scope |
|---|---|
| Операции по счетам ЮЛ | transactions |
| Входящие платежи по СБП для ЮЛ | b2b-sbp |