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