Документ содержит описание основных функциональных характеристик программного продукта «Платформа Webstore» (далее – Платформа, Webstore).

Платформа Webstore помогает реселлерам ПО осуществлять торговую деятельность в современных условиях. Больше не нужны склады и сложные цепочки поставок. Не нужно тратить время на ожидание - от заказа до получения проходит всего несколько секунд. Простое и понятное подключение через API позволяет реселлеру в кратчайшие сроки начать работу с платформой. Параллельно боевому контуру развернута тестовая среда, где партнер может проверить свою интеграцию в условиях аналогичных боевым.

Вступая в век повсеместной цифровизации, дистрибутор ПО не сможет обойтись без такого инструмента, как платформа Webstore. Она не просто упрощает бизнес, она является необходимым инструментом, без которого работа в новой реальности просто невозможна.

• Администраторы - лица, выполняющие контроль и управление пользователями, продуктами, заказами и настройками платформы Webstore.
• Реселлеры - лица, приобретающие электронные ключи посредством вызова API методов. Без доступа к web-интерфейсу платформы Webstore.

Платформа Webstore представляет собой закрытый функционал, доступ к которому осуществляется после авторизации. Вместе с дистрибутивом для установки платформы Webstore вы получаете 2 учетные записи:

• Администратора - логин admin пароль test.
• Реселлера - логин customer пароль test.

ВНИМАНИЕ! Рекомендуется поменять пароли предоставленных учетных записей после начала использования ПО!

Новые учетные записи для пользователей можно создать из под учетной записи с ролью Администратор.

После завершения установки и запуска программного продукта в форме авторизации укажите логин и пароль, нажмите :

После успешной авторизации откроется страница платформы, на которой слева расположен блок с основными разделами сервиса, в центре - первый функциональный раздел - Продукты.

Для выхода из учетной записи нажмите кнопку «Выход» в верхнем правом углу экрана:

Пользовательский интерфейс платформы Webstore обладает следующими возможностями:

Позволяет управлять продуктами и информацией о них, необходимой для осуществления заказа.

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

Для добавления нового продукта нажмите и заполните поля в модальном окне Добавление продукта. Для редактирования продукта - нажмите напротив названия продукта и так же в форме редактирования внесите необходимые изменения:

В модальных окнах Добавление продукта и Редактирование продукта поля, отмеченные звездочкой, являются обязательными для заполнения. Укажите Название продукта, Вендора, Партномер, Поставщика, выберите страну. Валюта реселлера устанавливается автоматически при выборе страны. Установите цену реселлера и цену РРЦ. Установите минимальное и максимальное количество единиц продукта, которое можно заказать единовременно. Отметьте галочкой в чекбоксе способ продажи ключей - через генератор или Со склада. Для сохранения внесенных изменений нажмите , для отмены редактирования – :

Если необходимо заблокировать продукт для заказа, или наоборот, разблокировать ранее закрытый, нажмите переключатель. - продукт доступен для заказа, - продукт заказать нельзя:

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

Для добавления ключей продукта на склад запишите их в поле ввода (каждый новый ключ с новой строки). Запишите через точку с запятой ссылки на активацию или скачивание продукта, если они предусмотрены. При нажатии на ключи записываются на склад:

После добавления на склад ключей продукта - эти ключи становятся доступными для просмотра в блоке Неотгруженные ключи.

Данный блок предоставляет возможность просмотреть в виде списка реализованные по заказам ключи. Для удобства поиска ключа (или заказа, чтобы посмотреть, какой в нем был реализован ключ) используйте фильтр по ключу, номеру строки заказа. По каждому ключу отображается следующая информация: дата добавления, дата продажи, номер строки заказа, ссылка (если предусмотрена).

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

Для сохранения внесенных изменений нажмите , для отмены – :

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

Для сохранения внесенных изменений нажмите , для отмены – :

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

Для добавления нового заказчика нажмите и заполните поля в модальном окне. Все поля являются обязательными для заполнения - Название заказчика, Страна (можно выбрать из выпадающего списка), код заказчика. Чтобы отредактировать информацию существующего заказчика воспользуйтесь фильтром для быстрого поиска, нажмите напротив названия заказчика и в форме редактирования внесите необходимые изменения. Проставьте галочку в чекбоксе, если нужно отображать заблокированных заказчиков. При нажатии на содержимое фильтра сбрасывается:

Для сохранения внесенных изменений нажмите , для отмены – :

Для блокировки заказчика переместите переключатель: - заказчик активен, - заказчик заблокирован и не сможет совершать заказы.

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

Для добавления нового логина нажмите и заполните поля в модальном окне. Все поля являются обязательными для заполнения - Логин, Email, Роль (выбрать из выпадающего списка), Заказчик (выбрать из выпадающего списка заказчика, которому принадлежит логин). Для редактирования - найдите нужный логин с помощью фильтра, нажмите напротив логина и в форме редактирования внесите необходимые изменения. Проставьте галочку в чекбоксе, если нужно отображать заблокированные логины:

Для сохранения внесенных изменений нажмите , для отмены – :

ВНИМАНИЕ! Пользователи, имеющие логины без роли Customer не имеют доступа к внешнему API!

Для изменения пароля нажмите , введите и подтвердите новый пароль:

Для блокировки логина пользователя переместите переключатель: - логин пользователя активен, - логин пользователя заблокирован и не сможет авторизоваться в системе.

Предоставляет возможность добавления новых и редактирования информации по уже существующим поставщикам электронных продуктов. Каждый поставщик относится к определенному вендору и имеет свой тип генератора электронных ключей. Для добавления нового поставщика нажмите и заполните поля в модальном окне. Все поля являются обязательными для заполнения - Название поставщика, Тип генератора (выберите из выпадающего списка), Вендор (выберите из выпадающего списка вендора, которому принадлежит поставщик), Страна (выберите в строке страну, для которой требуется настройка поставщика), JSON для подключения (введите в поле ввода данные json-файла). Для редактирования нажмите и в форме редактирования внесите необходимые изменения.

Для сохранения настроек поставщика нажмите , для отмены – :

ВНИМАНИЕ! Все настройки поставщика и создаваемые заказы являются тестовыми, ключи формирует псевдогенератор! Для создания настоящих заказов необходимо настроить и подключить поставщика в соответствующем разделе. Пример:

Предоставляет возможность просматривать информацию по заказам и выгружать ее в CSV-файл. По каждому заказу система выводит информацию: номер строки заказа, название продукта, партномер, вендор, стоимость для реселлера в валюте реселлера и количество ключей в заказе, статус заказа, дата создания, страна, код заказчика и логин. Для выгрузки списка выбранных заказов в CSV-файл нажмите . Чтобы найти нужные заказы воспользуйтесь фильтром - введите/выберите параметры и нажмите . Для сброса содержимого фильтра нажмите

Нажмите на строку заказа в списке, чтобы просмотреть ключи и ссылки, реализованные в этом заказе:

Интерфейс API платформы Webstore обладает следующими возможностями:

Адрес Swagger UI https://localhost:5000/swagger/index.html

Нажмите и в модальном окне введите логин и пароль:

Администратор - логин admin пароль test. Реселлер - логин customer пароль test.

ВНИМАНИЕ! Логины без роли Customer не имеют доступа к внешнему API!

Получение информации об аккаунте

Нет

Запрос

GET https://pipe-web-test01.dmzmont.org:8075/api/GetCustomerInfo

Ответ

{
  "name": "ООО Твой дом",
  "code": "D002355",
  "countryCode": "RU",
  "enable": true,
  "useLogin": "alexdom"
}

Получение списка доступных продуктов

Нет

Тип ProductInfo

Запрос

GET https://pipe-web-test01.dmzmont.org:8075/api/GetProducts

Ответ

[
  {
    "productName": "Kaspersky Anti-Virus Russian Edition. 2 устройства 1 Г базовая лицензия",
    "partNum": "KL1171RUBFS_mt",
    "vendorCode": "LABK",
    "min": 0,
    "max": null,
    "customerPrice": 1500,
    "customerCurrencyCode": "RUB",
    "endUserPrice": null,
    "endUserCurrencyCode": null
  },
  {
    "productName": "Office Home and Business 2016 Win AllLng PKLic Onln CEE Only C2R NR test",
    "partNum": "ABC-11111",
    "vendorCode": "MS",
    "min": 0,
    "max": null,
    "customerPrice": 1000,
    "customerCurrencyCode": "RUB",
    "endUserPrice": null,
    "endUserCurrencyCode": null
  }
]

Размещение заказа в системе Webstore.

Тип OrderLines

Тип SaleOrderLineResult

Тип ProductUnitResult

Тип KeyUnitResult

Тип LinkUnitResult

Запрос

POST https://pipe-web-test01.dmzmont.org:8075/api/AddOrder

{
  "orderNum": "asdfg",
  "orderLines": [
    {
      "orderLineNum": "asdfg-1",
      "quantity": 1,
      "partNum": "ABC-11111"
    }
  ]
}

Ответ

{
    "orderNum": "asdfg",
    "dateCreated": "2021-04-02T18:37:01.0292714+03:00",
    "status": 3,
    "orderLines": [
        {
            "orderLineNum": "asdfg-1",
            "dateCreated": "2021-04-02T18:37:01.2637508+03:00",
            "quantity": 1,
            "partNum": "ABC-11111",
            "customerPrice": 1000.00,
            "customerCurrency": "RUB",
            "status": 3,
            "productUnits": [
                {
                    "keys": [
                        {
                            "activationKey": "b6981f28-4bde-4dc6-9008-a91cd63ed26e",
                            "serialNumber": ""
                        }
                    ],
                    "links": []
                }  
            ]
        }
    ]
}

Получение информации о размещенном заказе.

Тип SaleOrderLineResult

Тип ProductUnitResult

Тип KeyUnitResult

Тип LinkUnitResult

Запрос

GET https://pipe-web-test01.dmzmont.org:8075/api/GetOrder?orderNum=asdfg

Ответ

{
    "orderNum": "asdfg",
    "dateCreated": "2021-04-02T18:37:01.029271+03:00",
    "status": 3,
    "orderLines": [
        {
            "orderLineNum": "asdfg-1",
            "dateCreated": "2021-04-02T18:37:01.26375+03:00",
            "quantity": 1,
            "partNum": "ABC-11111",
            "customerPrice": 1000.00,
            "customerCurrency": "RUB",
            "status": 3,
            "productUnits": [
                {
                    "keys": [
                        {
                            "activationKey": "b6981f28-4bde-4dc6-9008-a91cd63ed26e",
                            "serialNumber": ""
                        }
                    ],
                    "links": []
                },
            ]
        }
    ]
}

Возвращает описание одного продукта в заданной стране.

Тип SpecContract

Тип SpecTypeContract

Запрос

GET https://pipe-web-test01.dmzmont.org:8075/api/GetProductDescription?partNum=ABC-11111&countryCode=RU

Ответ

{
  "partNumber": "ABC-11111",
  "title": "MS Office 2013 Тестовый продукт MS",
  "urlImage": null,
  "orderNum": 1,
  "preview": "<html>\n<head>\n\t<title></title>\n</head>\n<body>\n<p>Управляйте жизнью и работой более эффективно благодаря доступу к документам через Интернет.</p>\n</body>\n</html>\n",
  "shortDescription": null,
  "fullDescription": null,
  "importantInformation": null,
  "systemRequirements": null,
  "installInfo": null,
  "eventText": null,
  "specs": [
    {
      "id": 26,
      "title": "Операционные системы",
      "value": "Windows",
      "specType": 1
    },
    {
      "id": 91,
      "title": "Количество устройств",
      "value": "15",
      "specType": 2
    },
    {
      "id": 170,
      "title": "Канал продаж",
      "value": "ESD",
      "specType": 1
    }
  ],
  "countryCode": "RU",
  "isContentAvailable": true,
  "measureUnit": null,
  "vendorCode": "MS"
}

Роль пользователя — это совокупность возможностей, которые получает пользователь Системы, входящий в определенное количество встроенных групп доступа, и оперирующий заданным функционалом.

Вендор — это физическое или юридическое лицо, которое производит и поставляет товары под собственным брендом.

Реселлер — это физическое или юридическое лицо, которое осуществляет продажу товаров или услуг других производителей и поставщиков.

Категория - это группа сущностей, объединенных общим свойством. Категории могут иметь древовидную структуру. Могут использоваться на стороне реселлера для группировки продуктов в логические блоки, например, для построения меню на сайте. Категории принадлежат одному или нескольким вендорам и содержат продукты и семейства.

Продукт - сущность, которая может содержать в себе описание продукта на различных языках. Важно отметить, что большинство продуктов в своем описании содержат список характеристик вида: название характеристики, ее значение и тип. Например, «Тип лицензии» - «Базовая» - «строка». Данные характеристики так же можно использовать для группировки продуктов и семейств при разработке собственных систем.

Заказ - это объединенная группа из одного и/или более продуктов, созданная конечным клиентом для оплаты.

Цена реселлера - расчётная цена, по которой происходит продажа продукта реселлеру с учётом всех скидок.

Цена РРЦ - рекомендуемая розничная цена продажи продукта конечному клиенту.

Пакет хостинга ASP.NET Core 3.1 https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-aspnetcore-3.1.13-windows-hosting-bundle-installer

PostgreSQL https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

http://monttechnology.com