Шаблон ссылки для заказа услуги через Витрину

Заказ клиентом новой подписки через Витрину реализован с помощью ссылки buylink ("байлинк"), привязанной к кнопке Купить сейчас (или Попробовать) на странице продукта (см. Страница продукта). Ссылка формируется по шаблону и содержит информацию, необходимую для заказа подписки. По ссылке выполняется переход в Панель управления Клиента для оформления заказа на покупку.

В этой статье:

Шаблон

Шаблон ссылки для заказа подписки через Витрину имеет следующую структуру:

{base_path}?shopping_cart_items[][plan_id]={plan_id}&shopping_cart_items[][plan_period_id]={plan_period_id}&shopping_cart_items[][resources][][id]={resource_id}&shopping_cart_items[][resources][][quantity]={resource_quantity}&shopping_cart_items[][type]=application&manager_key={manager_key}&order_type={order_type}&shopping_cart_items[][type]=topup&shopping_cart_items[][amount]={topup_amount}&skip_all_steps=1&_ga={ga_values}

Параметры в ссылке указываются через &. Часть параметров необязательная и может отсутствовать (см. описание и примеры ниже). Параметр shopping_cart_items[][type]=application не требует настройки и должен всегда присутствовать в ссылке без изменений.

Параметры

ПараметрОбязательный/ОпциональныйОписание
base_pathОбязательный

Основной путь ссылки. Зависит от параметра URL внешнего приложения (см. Настройки URL внешнего приложения в Основные настройки Customer Store):

plan_idОбязательныйID тарифного плана, на который заказывается подписка (см. Просмотр списка тарифных планов)
plan_period_idОбязательный

ID периода тарифного плана, на который заказывается подписка (см. Изменение периодов тарифного плана)

В Витрине на странице продукта для кнопки Купить сейчас автоматически подставляется ID периода, соответствующего минимальной цене подписки на этот тарифный план, для кнопки Попробовать — ID пробного периода (см. Страница продукта). Клиент может выбрать другой период на шаге конфигурации подписки в Панели управления Клиента.

resource_idОпциональный

ID ресурса, для которого указывается заказываемое количество в подписке. Если в подписку нужно добавить несколько ресурсов, resource_id и resource_quantity указываются парами

resource_quantityОпциональныйЗаказываемое количество ресурса с указанным ID. Обязательный для каждого resource_id
manager_keyОпциональный

Ключ менеджера, к которому необходимо автоматически привязать клиента при заказе подписки. При навигации по страницам Витрины сам параметр не добавляется к URL. Менеджер должен самостоятельно сообщить клиенту ссылку с указанием ключа. Ссылка с указанием ключа менеджера может быть на любую страницу Витрины.

Ключ менеджера чувствителен к регистру. Важно указывать в ссылке ключ так, как он указан на странице менеджера. Например, carter81 и Carter81 — это разные ключи, они не будут работать вместе для одного менеджера.

При заказе клиентом новой подписки через Витрину возможна автоматическая привязка клиента к определенному менеджеру. Для этого необходимо, чтобы выполнялись все следующие условия:

  • Менеджер имеет статус Активный и заполненный параметр Ключ (см. Добавление сотрудника).

  • Клиент перешел на любую страницу Витрины по ссылке с параметром &manager_key={manager_key}, где {manager_key} — значение параметра Ключ менеджера.

  • Клиент не привязан к какому-либо менеджеру или это новый клиент.

Информация о том, к какому менеджеру привязан клиент, доступна на странице клиента (см. Просмотр и обновление информации о клиенте).

При этом существуют следующие особенности:

  • У клиента информация о ключе сохраняется в cookies браузера сроком на 1 месяц, поэтому обычно повторное использование ссылки с указанием ключа для привязки клиента в течение этого периода не требуется: будет использована информация из cookies. Если cookies браузера были очищены, необходимо повторно воспользоваться ссылкой с указанием ключа.
  • После привязки клиента менеджер получит уведомления согласно событиям уведомлений Клиент создан и Менеджер клиента изменен (см. Создание события уведомлений).

Ссылки с параметром &manager_key также могут быть использованы для реферальной программы. Подробнее см. Настройка реферальной программы.

order_typeОпциональный

Значение параметра определяет тип заказа, который клиент оформляет, переходя по ссылке:

  • SalesOrder — заказ на покупку новой подписки.
  • RenewalOrder — заказ на продление существующей подписки.
  • ProlongOrder — заказ на пролонгацию существующей подписки.
  • ChangeOrder — заказ на изменение количества ресурсов в существующей подписке.
  • SwitchPlanOrder — заказ на смену тарифного плана существующей подписки.

Обязательность зависит от параметра URL внешнего приложения (см. Настройки URL внешнего приложения в Основные настройки Customer Store):

  • Обязательный, если параметр URL внешнего приложения заполнен. В этом случае &order_type=SalesOrder автоматически подставляется в ссылке, привязанной к кнопке Купить сейчас (или Попробовать) на странице продукта.
  • Опциональный, если параметр URL внешнего приложения пустой. В этом случае order_type не обрабатывается и может отсутствовать.
topup_amountОпциональный

Сумма для пополнения баланса клиента, которая будет требоваться для начала предоставления услуги. Указывается в валюте реселлера вне зависимости от валюты тарифного плана. Может использоваться только с заказом на нулевую сумму (например, для подписки с оплатой по факту потребления, тип биллинга Pay as you go, см. Pay as you go. Особенности формирования списаний) по модели Предоплата, если клиентам реселлера доступны действия с балансом (см. Управление финансовыми настройками).

При заказе клиентом новой подписки через Витрину по ссылке с параметром &shopping_cart_items[][type]=topup&shopping_cart_items[][amount]={topup_amount} будут созданы заказ на покупку с нулевой суммой и платеж на пополнение баланса клиента. Параметр topup_amount работает вместе с настройкой Предоплата для предоставления подписок в правиле предоставления тарифного плана (см. Создание правила предоставления): сумма платежа равна наибольшему из двух значений.

Наличие определенной суммы на балансе клиента необходимо, чтобы подписка не остановилась практически сразу после активации:

  1. Подписка с оплатой по факту потребления по модели Предоплата блокирует средства на балансе клиента только за фактически использованные ресурсы на стороне услуги.
  2. Первые данные о потреблении ресурсов на стороне услуги обычно поступают в платформу уже через час после активации подписки.
  3. Обязательная сумма для пополнения баланса клиента гарантирует, что у клиента будет достаточно средств, чтобы подписка продолжила работать, если ресурсы на стороне услуги начинают потребляться сразу после покупки.
skip_all_steps=1ОпциональныйПри заказе клиентом новой подписки через Витрину по ссылке с параметром &skip_all_steps=1 шаг конфигурации подписки с выбором периода и количества ресурсов в Панели управления Клиента будет пропущен. Рекомендуется использовать только при заказе подписок с типом биллинга Pay as you go (internal), так как для них не предусмотрен выбор количества ресурсов в Панели управления Клиента, а вместо этого используются квоты (см. также Заказ подписки с типом биллинга Pay as you go (internal) для Панели управления Оператора).
ga_valuesОпциональныйЗначения метки Google Analytics

Примеры

  1. Ссылка для покупки у реселлера test.activeplatform.com подписки на тарифный план с ID = 425 и период тарифного плана с ID = 1840:

    https://test.activeplatform.com/client/new_order?shopping_cart_items[][plan_id]=425&shopping_cart_items[][plan_period_id]=1840&shopping_cart_items[][type]=application&order_type=SalesOrder

  2. Ссылка для покупки у реселлера test.activeplatform.com подписки на тарифный план с ID = 425 и период тарифного плана с ID = 1840, с ключом менеджера ivanov22:

    https://test.activeplatform.com/client/new_order?shopping_cart_items[][plan_id]=425&shopping_cart_items[][plan_period_id]=1840&shopping_cart_items[][type]=application&manager_key=ivanov22&order_type=SalesOrder

  3. Ссылка для покупки у реселлера test.activeplatform.com подписки на тарифный план с ID = 569 и период тарифного плана с ID = 2072 c типом биллинга Pay as you go (internal) по модели Предоплата, сумма для пополнения баланса клиента 1000:

    https://test.activeplatform.com/client/new_order?shopping_cart_items[][plan_id]=569&shopping_cart_items[][plan_period_id]=2072&shopping_cart_items[][type]=application&shopping_cart_items[][type]=topup&shopping_cart_items[][amount]={1000}&skip_all_steps=1&order_type=SalesOrder