🚀 BizPulse API

API для расчета экономических показателей малого и среднего бизнеса

Описание

BizPulse API предоставляет мощный набор инструментов для анализа бизнес-данных. Наш API помогает малому и среднему бизнесу принимать обоснованные решения на основе классических методов экономического анализа.

📊 ABC Анализ

Классификация товаров/услуг по степени их важности для бизнеса (принцип Парето 80/20)

📈 XYZ Анализ

Анализ стабильности продаж на основе коэффициента вариации

Интерактивная документация

Полная интерактивная документация API доступна через Swagger UI:

📖 Swagger UI

📚 Документация API

Подробное описание каждого эндпоинта — что принимает и что возвращает:

📋 Описание

ABC анализ классифицирует товары/услуги по степени их важности для бизнеса на основе принципа Парето (80/20). Метод помогает выявить ключевые товары, которые приносят основной объем продаж.

📥 Принимаемые данные

Content-Type: application/json

Body: Объект с массивом товаров items

{
  "items": [
    {
      "name": "string    // Наименование товара/услуги
      "sales": number    // Объем продаж (в денежном выражении)
    }
  ]
}

Пример запроса:

{
  "items": [
    { "name": "Товар 1", "sales": 150000 },
    { "name": "Товар 2", "sales": 85000 },
    { "name": "Товар 3", "sales": 42000 }
  ]
}

📤 Возвращаемые данные

Status: 200 OK

Content-Type: application/json

Поля ответа:

  • items — массив объектов с результатами анализа каждого товара:
    • name (string) — наименование товара
    • sales (number) — объем продаж
    • share (number) — доля в общем объеме продаж (%)
    • cumulativeShare (number) — накопленная доля (%)
    • group (string: "A" | "B" | "C") — группа ABC
  • groupAShare (number) — суммарная доля группы A (%)
  • groupBShare (number) — суммарная доля группы B (%)
  • groupCShare (number) — суммарная доля группы C (%)
  • totalSales (number) — общий объем продаж
  • groupARecommendations (object) — рекомендации по группе A:
    • items (string[]) — список товаров в группе
    • recommendations (string) — текстовые рекомендации
    • description (string) — описание характеристики группы
  • groupBRecommendations (object) — рекомендации по группе B
  • groupCRecommendations (object) — рекомендации по группе C
  • overallRecommendations (string) — общие рекомендации по всему анализу

📋 Описание

XYZ анализ классифицирует товары/услуги по стабильности продаж на основе расчета коэффициента вариации. Метод помогает определить, насколько предсказуем спрос на каждый товар.

📥 Принимаемые данные

Content-Type: application/json

Body: Объект с массивом товаров items

{
  "items": [
    {
      "name": "string",      // Наименование товара/услуги
      "periods": [           // Данные о продажах по периодам
        {
          "period": "string",  // Наименование периода
          "sales": number      // Объем продаж за период
        }
      ]
    }
  ]
}

Пример запроса:

{
  "items": [
    {
      "name": "Товар 1",
      "periods": [
        { "period": "Январь", "sales": 10000 },
        { "period": "Февраль", "sales": 10500 },
        { "period": "Март", "sales": 10200 }
      ]
    }
  ]
}

📤 Возвращаемые данные

Status: 200 OK

Content-Type: application/json

Поля ответа:

  • items — массив объектов с результатами анализа каждого товара:
    • name (string) — наименование товара
    • mean (number) — среднее значение продаж
    • coefficientOfVariation (number) — коэффициент вариации (%)
    • group (string: "X" | "Y" | "Z") — группа XYZ
  • groupXCount (number) — количество товаров в группе X
  • groupYCount (number) — количество товаров в группе Y
  • groupZCount (number) — количество товаров в группе Z
  • groupXRecommendations (object) — рекомендации по группе X:
    • items (string[]) — список товаров в группе
    • recommendations (string) — текстовые рекомендации
    • description (string) — описание характеристики группы
  • groupYRecommendations (object) — рекомендации по группе Y
  • groupZRecommendations (object) — рекомендации по группе Z
  • overallRecommendations (string) — общие рекомендации по всему анализу

Тестирование API

Протестируйте API прямо со страницы — отправьте запрос и получите результат с рекомендациями:

POST /api/v1/analysis/abc

ABC анализ классифицирует товары по группам:
  • Группа A: Наиболее значимые (до 80% продаж) — фокус на этих товарах
  • Группа B: Средние (до 95%) — потенциал роста
  • Группа C: Наименее значимые (остальные 5%) — оптимизация ассортимента

POST /api/v1/analysis/xyz

XYZ анализ классифицирует товары по стабильности:
  • Группа X: Стабильные продажи (CV < 10%) — основа бизнеса
  • Группа Y: Изменяющиеся (CV 10-25%) — выявить причины колебаний
  • Группа Z: Случайные (CV > 25%) — минимизировать риски