# Подключение системы LoyaltyLab

### Входные данные (что требуется от клиента для первичной настройки системы)

 - Таблица с данными о пользователях карт лояльности
 Необходимые для нас поля:
    - `user_id` (идентификатор клиента)
 - Таблица с информацией о всех товарах ритейлера
 Необходимые для нас поля:
    - `product_id` (идентификатор продукта)
    - `product_name` (название продукта)
    - `product_price` (цена продукта)
 - Данные о всех транзакциях магазина за прошедший год, как от лояльных клиентов, так и от обычных.
 Необходимые для нас поля:
    - `transaction_id` (идентификатор транзакции)
    - `user_id` (если лояльный клиент)
    - `timestamp` (дата и время покупки)
 - Данные о содержании каждой транзакции.
  Необходимые для нас поля:
    - `transaction_id` (идентификатор транзакции)
    - `product_id` (идентификатор продукта)
    - `sale_amount` (размер скидки на конкретный товар в момент совершения транзакции)
    - `by_distribution` (`True`|`False`, был ли этот товар в недавней рассылке по какому-либо каналу связи)
    - `shop_id` (индентификатор магазина, в котором была совершена покупка)

Здесь перечислены только необходимые для нас поля, если вы можете предоставить больше данных (например, вес продукта, БЖУ и тд.), то это поможет нам улучшить предсказания.

Эти данные можно передать в любом удобном для Вас формате (`csv`, `sql` ...)

Массив данных может передаваться как онлайн: доступ к облачному хранилищу – так и оффлайн: очная передача жесткого диска с массивом или прямой доступ специалистов LoyaltyLab к серверам с данными.

### Входные данные при дальнейшей работы системы
LoyaltyLab предоставляет для Вас интерфейс `API`, к которому можно обращаться по протоколу `http` / `https`
К нему вы будете обращаться после каждой покупки лояльного пользователя и передавать данные о транзакции. Эти данные необходимы для поддержания релевантности рекомендаций нашей системы.

Пример запроса к нашему `API` в формате `JSON`:
```js
{
    user_id: 123, // идентификатор пользователя
    products: [1, 2, 3, 4], // массив купленных пользователем продуктов
    timestamp: 12345678 // дата и время покупки
}
```

### Выходные данные (как мы передаём данные клиенту)

##### Первый вариант

LoyaltyLab предоставляет для Вас интерфейс `API`, к которому можно обращаться по протоколу `http` / `https` в обговоренные рамки времени, и мы будем Вам возвращать массив рекомендаций для ваших клиентов.

Пример ответа нашего сервиса в формате `JSON` на запрос:
```js
{
    recommendations: [
        {
            user_id: 123, // идентификатор клиента
            timestamp: 12345678, // дата и время, когда клиент придет в магазин
            needed_products: [1, 2, 3, 4], // продукты за которыми клиент пришел в магазин (что и так купит)
            products_to_push: [5, 6, 7, 8], // продукты, которые может купить по рекомендации
            products_for_sale: [9, 10, 11, 12] // продукты, которые может купить, если предоставить скидку
        },
        ... // и так по всем пользователям, которые в ближайшие дни совершили у вас покупки
    ]
}
```

##### Второй вариант
Специалисты LoyaltyLab сами в указанные сроки будут выгружать вам `csv` файл со всему рекомендациями для клиентов на назначенную дату