Настройка получения лицензии через ваш веб-сервис
Обзор возможностей
Веб-сервис – это способ генерации лицензий для электронной доставки продуктов покупателям.
При этом способе доставки на вашей стороне должен быть разработан веб-сервис, который будет по запросу с нашей стороны генерировать лицензию на продукт и возвращать ее в ответе. Мы отправим полученную лицензию на почту покупателю.
Поддерживается:
- Метод передачи данных: POST или GET
- Формат лицензий: текст
Если лицензия является файлом, то она должна быть сохранена на вашей стороне и быть доступна по ссылке. В качестве лицензии вы передаете ссылку на файл с ней
Безопасность взаимодействия обеспечивается с помощью проверки подписи в заголовке каждого запроса.
Настройка доставки впервые
Основные настройки
Если вы ранее не настраивали доставку для своих продуктов:
- Откройте Merchant Portal и пройдите авторизацию
- Перейдите в раздел Продукты / Каталог
У вас должен быть создан хотя бы один продукт, чтобы настройка доставки стала доступна. В этом случае после формы поиска вы увидите блок настройки доставки - Нажмите Подключить в блоке доставки
- Выберите способ генерации лицензии - Веб-сервис (или Тестовый веб-сервис, если вы работаете в тестовом режиме)
- Заполните URL веб-сервиса – это адрес веб-сервиса на вашей стороне, который будет получать запросы на генерацию лицензии. URL должен быть доступен по протоколу HTTPS
- Выберите метод передачи данных:
- GET - параметры будут переданы вашему веб-сервису в URL в виде:
http://[endpoint-url-вашего-веб-сервиса]?=[название_параметра1]=[значение_параметра1]&[название_параметра2]=[значение_параметра2] - POST - параметры будут переданы в теле запроса в формате JSON
- GET - параметры будут переданы вашему веб-сервису в URL в виде:
- Заполните секретный ключ - это значение будет использоваться при генерации подписи запроса к веб-сервису
- Выберите количество лицензий, которое нужно отправлять для продукта в заказе:
- 1 лицензия на единицу продукта - при заказе нескольких штук одного и того же продукта, нужно отправить покупателю такое же количество лицензий (например, в заказе 5 штук одного продукта, нужно отправить 5 лицензий). Если этот вариант выбран, то мы отправим отдельный запрос на получение лицензии для каждой единицы одного и того же продукта в заказе. Все полученные лицензии будут отправлену покупателю на почту в одном письме
- 1 лицензия на продукт - для продукта нужно отправить одну лицензию, независимо от количества приобретенных единиц (например, в заказе 5 штук одного продукта, нужно отправить только одну, общую, лицензию)
- Настройте отправку письма с лицензией покупателю
- (Опционально) Добавьте данные о заказе/продукте/покупателе к запросу с помощью параметров
- Вы можете протестировать отправку запроса перед сохранением веб-сервиса
- Нажмите кнопку Сохранить
Письмо с лицензией
При настройке доставки с помощью веб-сервиса вы можете также настроить письмо с лицензией, которая будет отправлена покупателю.
Вам доступно два варианта:
Параметры запроса
Вы можете управлять данными, которые будут переданы в запросе к вашему веб-сервису. По умолчанию запрос не содержит каких-либо данных.
Для управления параметрами запроса на странице настройки доставки через веб-сервис:
- Нажмите + Добавить, чтобы добавить параметр к запросу
- Появится форма из двух полей: название параметра и значение параметра
- Выберите значение параметра во втором поле. Это то свойство заказа или продукта, которое будет передано вашему веб-сервису
- Измените название параметра в первом поле, если необходимо
Пример передачи параметров
Предположим:
- Ваш веб-сервис доступен по адресу: https://you-company.com/license
- Вы хотите, чтобы в запросе были переданы:
- Номер заказа
- ID продукта
- Количество продукта в заказе
- Валюта заказа
- Значение дополнительного параметра Referer1
- Покупатель оплатил заказ № 19583505 на 1 шт. продукта с идентификатором 19583478 (валюта: рубли, значение Referer1: 123)
В этом случае:
- При использовании метода GET:
- Мы отправим запрос на лицензию к вашему веб-сервису на адрес:
https://you-company.com/license?Order=19583505&ID=19583478&Quantity=1&Currency=RUB&Referer1=123
- При использовании метода POST:
- Мы отправим запрос на лицензию к вашему веб-сервису на адрес: https://you-company.com/license
- Тело запроса будет содержать параметры:
{
"Order": "19583505",
"ID": "19583478",
"Quantity": "1",
"Currency": "RUB",
"Referer1": "123"
}
Изменение настроек
Если вы уже настроили доставку для продуктов, и хотите изменить настройки:
- Откройте Merchant Portal и пройдите авторизацию
- Перейдите в раздел Продукты / Каталог
У вас должен быть создан хотя бы один продукт, чтобы настройка доставки стала доступна. В этом случае после формы поиска вы увидите блок настройки доставки - Нажмите Изменить в блоке доставки
- Отредактируйте значения полей:
- Если ранее вы использовали иной способ генерации лицензии и хотите переключиться на использование веб-сервиса, то выберите Веб-сервис (или Тестовый веб-сервис, если вы работаете в тестовом режиме) в соответствующем поле
- Дальнейшие настройки выполняются аналогично, как при первичной настройке веб-сервиса
Обратите внимание, изменение настроек доставки повлияет на все ваши продукты. Т.е. и ранее созданные продукты, и новые будут использовать доставку через веб-сервис.
Работа вашего веб-сервиса
Узнайте подробнее:
- Как обеспечить безопасность взаимодействия с помощью проверки подписи
- Как ваш веб-сервис должен отвечать на запрос лицензии
- Как обрабатываются ошибки взаимодействия с веб-сервисом
Тестирование
После того, как вы заполнили форму настройки доставки через веб-сервис, вы можете протестировать сделанные настройки. При этом вам не обязательно сохранять изменение настроек веб-сервиса.
Отправка тестового запроса к веб-сервису
С помощью этой функции вы можете отправить запрос к вашему веб-сервису, без необходимости покупать продукт через корзину.
Для этого:
- На странице настроек доставки через веб-сервис нажмите кнопку Тестировать
- Система автоматически выполнит запрос к вашему веб-сервису на основании текущих настроек доставки. Если запрос содержит параметры, то в них будут поставлены тестовые значения
- Информацию о выполненном запросе и полученный ответ вашего веб-сервиса вы увидите в модальном окне
При выполнении тестового запроса никаких дополнительных действий по обработке доставки продукта не совершается (не отправляется письмо с лицензией и вебхук-оповещение). Происходит только отправка запроса.
Тестовая покупка
Эмуляция работы веб-сервиса на вашей стороне
Если вы еще не разработали веб-сервис и хотите посмотреть пример запроса на своей стороне, то вы можете использовать эмуляцию веб-сервиса. Для этого вам нужно настроить тестовый веб-сервис, который будет принимать запросы, на специальном ресурсе.
Наш эмулятор веб-сервиса
Если вы хотите протестировать обработку доставки (например, получение вебхук-оповещения, письма с лицензией и т.п.), но у вас еще нет веб-сервиса и вы не хотите настраивать эмулятор на своей стороне, то вы можете подключить нашу эмуляцию веб-сервиса.
Это наш веб-сервис, который выдает тестовые лицензии по запросу. Узнайте подробнее, как это сделать.