Подключение вебхуков
Начало работы
Для того, чтобы начать принимать оповещения:
- Ознакомьтесь с документацией по интеграции.
- Разработайте веб-сервис для получения вебхуков на своей стороне.
Обратите внимание:- Вы можете использовать отдельные адреса для получения оповещений по разным событиям или указать для каждого события один и тот же URL.
- Каждый вебхук имеет подпись (signature), с помощью которой вы можете удостовериться, что он отправлен именно нами. Реализуйте проверку подписи на своей стороне для повышения безопасности взаимодействия.
- Ваш веб-сервис должен отвечать на вебхук определенным образом.
- Подключите отправку вебхуков через Merchant Portal. Для этого создайте эндпоинт для каждого события, по которому вы хотите получать вебхуки.
Создание эндопоинта
Чтобы настроить отправку оповещений по определенному событию, создайте эндпоинт.
Для этого:
- Откройте Merchant Portal и пройдите авторизацию.
- Перейдите в раздел Вебхуки.
- Нажмите кнопку Создать эндпоинт в верхней части страницы.
- Заполните URL эндпоинта – это адрес веб-сервиса на вашей стороне, который будет получать оповещения о событии (Event).
Требования к URL:- Должен быть доступен по протоколу HTTPS.
- Может быть не уникальным.
То есть вы можете указать в разных эндпоинтах один и тот же или разные URL.
- Выберите событие, о котором вы будете получать оповещения на URL эндпоинта.
Обратите внимание, вы можете создать только один эндпоинт для каждого события:
Событие Event Softline Checkout Softline Payments Заказ создан order.created Используется Используется, отправляется в момент создания ссылки на оплату (это момент создания платежа) Заказ успешно оплачен order.payment.succeeded Используется Используется Оплата заказа не прошла order.payment.failed Используется Используется Продукт доставлен product.delivered Используется Не используется Продукт возвращен product.returned Используется Используется Подписка отменена subscription.cancelled Используется Не используется Подписка восстановлена subscription.restored Используется Не используется - Заполните секретный ключ – это значение будет использоваться при генерации подписи вебхука.
- Нажмите кнопку Сохранить.
Новый эндпоинт создается в статусе Активирован. В этом статусе оповещение по событию будет отправлено на URL эндпоинта при наступлении события. Если вы хотите приостановить оповещения, деактивируйте эндпоинт.