Реклама і банери

В цьому розділі описано роботу з рекламою. Базова адреса для функцій даного розділу /advertising/.

Отримати випадковий банер

GET /advertising/banner/random
Query Parameters:
 
  • banner_code – Тип банеру.
  • advert – ID Акції.

Приклад відповіді:

{
  "banner": {
    "uuid": "B691005056BA876F11EC0A62A4D7CFA6",
    "banner_url": "https://b2b.bm.parts/img/banners/solgy_cup.jpg",
    "banner_code": "home"
  }
}

Отримати список банерів

GET /advertising/banners
Query Parameters:
 
  • banner_code – Тип банера.
  • advert – ID Акції.

Приклад відповіді:

{
  "banners": [
    {
      "uuid":"81DC005056AC66D611E92552352FD2C2",
      "banner_code": "home",
      "banner_url": "https://b2b.bm.parts/img/banners/solgy_cup.jpg",
      "has_children": true
    }
  ]
}

Отримати список акцій

GET /advertising/list

Метод вертає список активних рекламних компаній.

Приклад відповіді:

{
  "adverts": [
    {
      "end_at": "2018-05-30T00:00:00Z",
      "begin_at": "2018-05-01T00:00:00Z",
      "name": "Чашка в подарунок до кожного насосу ГУР от Solgy",
        "banners": {
            "home": {
              "banner_code": "home",
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg"
            },
            "app": {
              "banner_code": "app",
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_700-320_lottery.jpg"
            },
            "busmarket_": {
              "banner_code": "busmarket_",
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg"
            }
          },
       "description": "действующая <b>акция</b>",
       "uuid": "811C005056AC1EA911E853995D337585",
       "show_progress": true,
       "finished": false,
       "target_type": 0,
       "periodicity": 1,
       "one_time_gift": false,
       "is_member": false,
       "children_count": 1,
       "has_children": true,
       "count_of_active_promos": 1
      }
    ]
}

Прогрес акції

GET /advertising/promo/(promo_uuid)/progress
Query Parameters:
 
  • promo_uuid – ID акції (Обов’язковий).)
Параметр Опис
uuid Ідентифікатор акції
name Назва акції
finished Чи закінчена акція: true, false
progress_period Період, за який розраховується виконання акції, може бути Весь період акції, місяць, поточний тиждень, сьогодні
progress Сума або кількість продажів по цілі
show_progress Обчислюється прогрес по даній акції (показувати прогрес)
target_type Вид цілі акції. Може приймати значення: eur, qnt
percentage Позиція вказівника
progress_total Всього виконано за розрахунковий період акції
promo_type Тип акції: рейтингова або накопичувальна
place Позиція в конкурсі
one_time_gift Разовий подарунок
nearest_gift_in Найближчий подарунок
nearest_place_in Лишилось накопичити
total Обіг
gifts[] Масив з подарунками з акції
gifts[].uuid Ідентифікатор подарунку
gifts[].count Кількість зароблених подарунків
gifts[].target Ціль, яку потрібно досягнути, щоб заробити подарунок
gifts[].default_image Зображення подарунку
gifts[].percentage Відсоток для відображення
gifts[].title Назва подарунку
winners_number Кількість призових місць

Приклад відповіді:

{
  "uuid": "81CA005056AC66D611E87DF8B8260B43",
  "name": "Фірмові бірки від..",
  "target_type": "Кол-во",
  "show_progress": true,
  "one_time_gift": false,
  "progress_total": 0.00,
  "progress_period": "В этом месяце",
  "percentage": 0.00,
  "promo_type": "accumulation",
  "winners_number": 0,
  "place": null,
  "total": null,
  "nearest_place_in": null,
  "nearest_gift_in": 50.000,
  "finished": false,
  "gifts": [
    {
      "percentage": 100.00,
      "uuid": "913E75269237F7EC40E288B0E5B92A9D",
      "target": 50.000,
      "title": "Бирка для замены масла .. (1к-кт = 50 шт)",
      "default_image": "https://cdn.bm.parts/photos/320x320/g/w/v/p/t/e4806f3f.jpeg",
      "count": 0
    }
  ]
}

Отримати акцію

GET /advertising/promo/(promo_uuid)
Параметр Опис
promo_uuid ID акції (Обов’язковий).
public Публічний опис акції.

Приклад відповіді:

{
  "adverts": {
    "uuid": "B6A3005056BA86AD11EC002A67B56744",
    "finished": false,
    "target_type": 0,
    "description": "<div><span>діюча акція</span></div>",
    "banners": {
      "home": {
        "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg",
        "banner_code": "home"
      },
      "app": {
        "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_700-320_lottery.jpg",
        "banner_code": "app"
      },
      "busmarket_": {
        "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg",
        "banner_code": "busmarket_"
      }
    },
    "show_progress": true,
    "periodicity": 0,
    "one_time_gift": true,
    "name": "Розіграш призів разом з MEYLE",
    "begin_at": "2021-09-01T00:00:00+00:00",
    "end_at": "2022-01-30T00:00:00+00:00",
    "is_member": false,
    "count_of_active_promos": 1,
    "children": [
      {
        "uuid": "92F1005056BA7D7A11EF06F85EB812C1",
        "finished": false,
        "target_type": 0,
        "begin_at": "2024-05-01T00:00:00Z",
        "periodicity": 0,
        "end_at": "2024-06-30T00:00:00Z",
        "description": "<div><span>Опис акції</span></div>",
        "banners": {
          "home": {
            "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2024/meyle_rating_800-500_braking.jpg",
            "banner_code": "home"
          },
            "app": {
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2024/meyle_rating_700-320_braking.jpg",
              "banner_code": "app"
            },
            "busmarket_": {
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2024/meyle_rating_800-500_braking.jpg",
              "banner_code": "busmarket_"
            }
          },
        "name": "Призи для 5 найкращих СТО від MEYLE",
        "show_progress": true,
        "one_time_gift": false,
        "is_member": false
      }
    ],
  }
}

Реєстрація на ІТП із вибором цілі і подарунку

POST /advertising/(pso_uuid)/registration
query pso_uuid:UUID акції (Обов’язковий).

Приклад body запиту:
{
“gift_uuid”: “BF214E7F037004B84B815D85ADD093A1”, “target”: 500

}

Приклад успішної відповіді (200 status code):
{
“success”: true

}

Якщо ІТП недоступна для даного контрагента, витік термін реєстрації або акція не являється ІТП - повернеться response (404 status code):
{
“message”: “Ресурс не знайдено”, “documentation_url”: “https://developer.bm.parts/api/v2/“

}

Якщо target або gift_uuid невалідний (422 status code):
{
“message”: “Вказано невалідний target/gift_uuid”, “documentation_url”: “https://developer.bm.parts/api/v2/“

}

Отримати список цілей і призів по вказаному ІТП

GET /advertising/(pso_uuid)/plans
query pso_uuid:UUID акції (Обов’язковий).

Приклад відповіді:

{
  "targets": [
    {
      "target_type": "EUR",
      "target": 500,
      "is_selected": true",
      "gifts": [
        {
          "uuid": "A2946EF92E4C4AFB46C58456C9D217A5",
          "default_image": "https://cdn.bm.parts/photos/320x320/i/h/y/z/i/8971d590.jpeg",
          "name": "Годинник",
          "article": "53156",
          "is_selected": true"
        },
        {
          "uuid": "BF214E7F037004B84B815D85ADD093A1",
          "default_image": "https://cdn.bm.parts/photos/320x320/f/f/f/i/r/1f4a5fd1.jpeg",
          "name": "Колодки гальмівні (передні) Renault Trafic II/Opel Vivaro A/Nissan Primastar 01-",
          "article": "141315LM",
          "is_selected": false
        }
      ]
    },
    {
      "target_type": "EUR",
      "target": 2000,
      "is_selected": false,
      "gifts": [
        {
          "uuid": "8284E1356FFD415F4A51146FB29B6235",
          "default_image": "https://cdn.bm.parts/photos/320x320/j/d/o/k/p/7d748fcf.jpeg",
          "name": "Олива 85W140 HD (60L) (GL-4/GL-5)",
          "article": "317604",
          "is_selected": false
        }
      ]
    }
  ]
}