Начало работы

  • Изучите документацию по работе с API
  • Получите доступ к API:
    • Если вы используете Merchant Portal, то воспользуйтесь разделом API keys, чтобы создать учетные записи для работы с API для тестовой и боевой среды
    • В ином случае обратитесь в службу поддержки для настройки доступа. Обратите внимание, доступ к API в тестовой среде предоставляется отдельно, если вы хотите использовать API в тестовой среде, то уточните это при обращении в службу поддержки
  • Вам будут предоставлены данные для подключения
  • Настройте базовые продукты 
    Свойства этих продуктов будут использоваться как значения по умолчанию для продуктов с динамическими свойствами. Вы можете создать базовые продукты самостоятельно (через Merchant Portal или Product API) или обратившись в службу поддержки. При обращении в службу поддержки опишите, сколько продуктов одновременно вы хотите добавлять в корзину, и какие настройки базовых свойств этих продуктов нам нужно сделать. 
  • Разработайте на своей стороне:
    • Веб-сервис для получения авторизационного токена через Authentication API, если это не было сделано ранее при подключении к другому нашему API
    • Веб-сервис для взаимодействия с Dynamic Product Checkout API

Для работы с API предоставляются данные:

  • Username и password, для авторизации через Authentication API, если это не было сделано ранее при подключении к другому нашему API.
  • Идентификаторы базовых продуктов, которые вы можете использовать в запросе. 

Базовый продукт - это тот продукт, на основе которого происходит добавление в корзину продукта с динамическими характеристиками. Вы передаете идентификатор базового продукта при запросе к API.

Базовые продукты используются для:

  • Определения свойств продукта по умолчанию.
    При добавлении динамического продукта в корзину часть его свойств будет взята из запроса, а другая часть свойств - из свойств базового продукта. Можно настроить несколько базовых продуктов с разными значениями свойств. 
  • Добавления в корзину несколько продуктов.
    Если вы хотите, чтобы по ссылке на покупку в корзину можно было добавить сразу несколько продуктов, то для этого должны быть настроены отдельные базовые продукты. Нельзя добавить несколько динамических продуктов в корзину на основе одного и того же базового продукта. 

Ниже перечислены те свойства, которые настраиваются при подключении. В таблице указано, какие из них можно переопределить через запрос к API.


Обратите внимание. Если свойство не переопределено в запросе, то его значение будет взято из базового продукта, и будет одинаковым у всех продуктов с динамическими характеристиками на основе этого базового продукта.

Свойство Описание
Доступные валюты продажи Определяет валюты, в которых может продаваться продукт. Настраивается в соответствии с вашим договором.
Изображение продукта (Опционально) Если загружено, то отображается для продукта в корзине.
Описание продукта (Опционально) Если заполнено, то для продукта в корзине отображается иконка, при нажатии на которую открывается описание.
Особенности налогообложения
Способ начисления VAT (НДС)

Определяет способ начисления VAT на цену продукта. Настраивается в соответствии с вашим договором.
Варианты значения:

  • VAT включен в цену - покупатель увидит в корзине ту цену, которая передана для продукта в запросе,
  • VAT начисляется сверху цены при добавлении продукта в корзину, то есть цена, переданная в запросе, будет увеличена в корзине на сумму налога. Ставка VAT определяется автоматически в соответствии с выбранной страной покупателя.
Начисление НДС
при продаже в российских рублях

Только при продаже продукта в российских рублях. Варианты значения:

  • НДС начисляется (согласно выбранному способу).
  • Продукт не облагается НДС.

Данное свойство может быть переопределено в запросе (products.vat_included).
Для продаж в других валютах VAT начисляется всегда. Ставка определяется автоматически и зависит от страны продажи.

Наличие программы в едином реестре Российского ПО
при продаже в российских рублях

Только при продаже продукта в российских рублях. Варианты значения:

  • Программа внесена в реестр.
  • Программа не внесена в реестр.

Если программа не внесена в единый реестр российского ПО (https://reestr.digital.gov.ru/), то она облагается НДС (закон 265-ФЗ).

Особенности отображения продукта в корзине
Скрытие количества продукта в корзине Позволяет скрыть количество продукта в корзине.
Независимо от настройки: количество определяется из запроса к API и не может быть изменено покупателем.
Комментарии для продукта в корзине Выводится рядом с названием продукта в корзине или внизу страницы корзины рядом с кнопкой продолжения оформления заказа.
Рядом с названием можно отобразить до 4х комментариев, в том числе 1 из них может отображаться только в случае, если согласие на автоматическое продление лицензии включено.
Особенности доставки продукта
Способ выполнения заказа

Варианты значения:

  • Электронная доставка (лицензионная информация отправляется покупателю на email).
  • Физическая доставка.

Данное свойство может быть переопределено в запросе (products.is_delivery_needed).

Способ электронной доставки

Для продуктов с электронным способом доставки (на email).

Изучите возможные варианты и сообщите в службу поддержки, какой вариант вам подходит. 

Настройки продажи продлений
Поддерживаются только подписки с автоматическим продлением (AR). Использование подписок с бесплатным пробным периодом (AR Trial) или продлением вручную (PMR) пока не доступно. Узнайте подробнее о продаже подписок для динамических продуктов.
Включение подписок с автоматическим продлением  Если включено, то для продукта могут быть переданы данные по подписке в запросе (products.subscription).
Срок действия продления Период, в течение которого покупатель может использовать приобретенный продукт.
Значение из базового продукта используется для продукта продления (дочерний продукт).
Название продления

Используется в дочернем заказе на продление.

Данное свойство может быть переопределено в запросе (products.subscription.name).

Цена за единицу продукта продления

Используется в дочернем заказе на продление.

Данное свойство может быть переопределено в запросе (products.subscription.price).