Авторизация#
| Метод | Что делает | Тариф |
|---|---|---|
POST /auth/token | Меняет client_id и client_secret на токен на час | — |
Справочники#
Меняются редко, их стоит кэшировать на стороне интеграции.
| Метод | Что отдаёт | Тариф | Страницы |
|---|---|---|---|
GET /shopping_centers | Торговые центры, где у владельца ключа есть роль | BASIC | нет |
GET /sc/{sc_id}/shops | Торговые точки центра | BASIC | до 500 |
GET /sc/{sc_id}/shops/{shop_id}/kkts | Кассы точки и их состояние | BASIC | нет |
GET /sc/{sc_id}/traffic_areas | Зоны подсчёта посещаемости | BASIC | нет |
GET /sc/{sc_id}/shops/{shop_id}/turnover_config | Правила расчёта товарооборота | BASIC | нет |
Данные#
| Метод | Что отдаёт | Тариф | Страницы | Период |
|---|---|---|---|---|
GET /sc/{sc_id}/reports/shops/{shop_id}/by_days | Продажи точки по дням | BASIC | до 366 | окно тарифа |
GET /sc/{sc_id}/reports/shops/{shop_id}/by_months | Месячные итоги, на PRO плюс три поля аналитики | BASIC | нет | 12 месяцев на Basic, 36 на PRO |
GET /sc/{sc_id}/shops/{shop_id}/receipts | Почековая выгрузка | PRO | до 1000 | 31 день на пару дат |
GET /sc/{sc_id}/attendance | Посещаемость центра, зоны или точки | BASIC | нет | окно тарифа, для часов 31 день |
GET /sc/{sc_id}/anomalies | Отклонения в продажах | PRO | до 500 | окно тарифа |
POST /sc/{sc_id}/events | Акции, распродажи, ремонты | BASIC | — | — |
Передача данных#
Обратное направление: не выгрузка, а приём. Доступно на любом тарифе.
| Метод | Что делает | Тариф |
|---|---|---|
POST /sc/{sc_id}/shops/{shop_id}/turnover | Сданный товарооборот точки за месяц | BASIC |
POST /sc/{sc_id}/attendance | Посещаемость за сутки по центру или зоне | BASIC |
POST /sc/{sc_id}/sensors/{external_id}/traffic | Почасовая выгрузка со счётчика | BASIC |
«Окно тарифа» это 31 день и данные до вчера на Basic, 366 дней и сегодня на PRO. У месячных итогов предел задан в месяцах, а не в днях, он указан в строке отдельно. Подробности в разделе Тарифы.
Что закрыто тарифом#
Целиком доступны только на PRO два метода: чеки и аномалии. Ещё два места гейтятся не методом, а значением параметра:
| Где | Значение | Тариф |
|---|---|---|
attendance, granularity | hour | PRO |
attendance, scope | zone, shop | PRO |
В продажах по месяцам на PRO дополнительно приходят average_check_sum,
revenue_per_area и ocr. На Basic этих ключей в объекте нет.
Базовый URL#
https://api.rentu.ru/api/external/v2Стенд для проверок: https://stage-api.rentu.ru/api/external/v2, у него свои данные
и свои ключи.
Все методы, кроме выдачи токена, требуют заголовок Authorization: Bearer <token>.
Полный список кодов ошибок в разделе Ошибки, правила подсчёта
частоты в разделе Лимиты.