Инструменты пользователя

Инструменты сайта

  • ru

Руководство по API Webstore

1. Введение 
2. Определения и термины
3. Основные возможности
4. Группы пользователей Webstore 
5. Авторизация 
6. Методы
7. Коды ошибок
8. Ссылки

1. Введение

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

2. Определения и термины

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

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

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

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

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

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

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

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

3. Основные возможности

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

Платформа Webstore решает следующие задачи:

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

4. Группы пользователей

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

5. Авторизация

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

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

6. Методы

GetCustomerInfo - получение информации об аккаунте

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

AddOrder - размещение заказа в системе Webstore

GetOrder - получение информации о размещенном заказе

GetProductDescription - получение информации о продукте

7. Коды ошибок

КодТекст ошибки
101Заказ с таким номером уже есть в системе
102Для логина не назначена ни одна компания
103Неизвестная страна
104Логин не найден в системе
105Продукт не найден
106Минимальное количество для товара не достигнуто
107Превышено максимальное количество для товара
108Строка заказа с таким номером уже есть в системе
109Для товара не настроен онлайн генератор
110Для онлайн генератора не настроены параметры

8. Ссылки