API Documentation (1.0)

Download OpenAPI specification:Download

Attendances

Create attendace

Внесение данных посещаемости вручную

path Parameters
sc_id
string
Example: 6a056705f409ba80c7780be3
header Parameters
Accept
any
Example: application/json
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MDVmNDA5YmE4MGM3NzgwYmU4In0.BBopu6N2SxjL6VS7SmybRZbVKbz1ziaQa0JZyyLaOGf1KzymdtL1qCIbcri303YCs5N7odBtnCtowxECTMj1Bg
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
Example
{
  • "date": "2026-05-14",
  • "value": 1488
}

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true
}

Auth

Login

Авторизация. Параметр phone — телефон в формате +7XXXXXXXXXX (10 цифр после +7). Также допускаются форматы: +7 (XXX) XXX-XX-XX и +7 XXX XXX XX XX.

header Parameters
Accept
any
Example: application/json
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
Example
{
  • "phone": "+7 800 555 35 35",
  • "password": "vAk6F7hVjS",
  • "token": "82b0daee89e766fc3081fa59829943b67174afc7f2ecc04dbed3efd295405395e23ad745d4e4b8611bb21f4d691e1806ed3d5a106ff176b5891acf6d4bfb3add"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "token": "eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MDZmNDA5YmE4MGM3NzgwYmZlIiwiZXhwIjoxNzc4NzgyMTUwfQ.KLPMRFbQ9WT97forF7LuY-S2NTDLzxV3IeYwwu8BCzU8VI6wNI41UliH8ofQAxL4qlzEfC3s7og_a5eUhYF2Rg"
}

Kkts

Show sell_location's kkts

Получение информации по кассам торговой точки ТЦ

path Parameters
sc_id
string
Example: 6a056706f409ba80c7780c01
shop_id
string
Example: 6a056706f409ba80c7780c04
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MDZmNDA5YmE4MGM3NzgwYzE2In0.IDeRZm35GygXe5XITwhvHOGs2jtNe7sFJcTkgASj44c6iUc6IgHf5Owm4F06AZvdKTodlmNW7gJf09dRYChWTA

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "kkts": [
    ]
}

Show sell_location's kkt

Получение информации по кассе торговой точки ТЦ

path Parameters
sc_id
string
Example: 6a056707f409ba80c7780c46
shop_id
string
Example: 6a056707f409ba80c7780c49
id
string
Example: 6a056707f409ba80c7780c58
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MDhmNDA5YmE4MGM3NzgwYzViIn0.PE3QpKEt3kjqO89slj3ws67lcipD65kS9KGfd1WluNgRPbbLlhIPqyGpWO2MdE8DMNS7Hqzs-2EIl73TGAkIAQ

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "kkt": {
    }
}

Arendators

Show arendators' list

Получение информации по арендаторам в ТЦ

path Parameters
sc_id
string
Example: 6a056708f409ba80c7780c9e
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MDlmNDA5YmE4MGM3NzgwY2E0In0.xuO0QfMsV7g63fTy50MZB79G5HWoMq0XFx2gjLDllAGRpVvxRHf1UIcYPgOAvYw43MY6rTtu8wOoZWbp18eHTw

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "renters": [
    ]
}

Show arendator's shops

Получение информации по торговым точкам арендатора в ТЦ

path Parameters
sc_id
string
Example: 6a056709f409ba80c7780cae
id
string
Example: 6a056709f409ba80c7780cb1
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MDlmNDA5YmE4MGM3NzgwY2U3In0.xbFbZzC8BSbiHS6JtNs_J-2Pxyr1UZBScYMNeW6t3R4VbXC72TAtUuhX-7vWVSMwb_YWzUrNXDuzlhxugc_Xnw

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "shops": [
    ]
}

Show arendator's info

Получение информации по арендатору в ТЦ

path Parameters
sc_id
string
Example: 6a05670bf409ba80c7780d5f
id
string
Example: 6a05670bf409ba80c7780d62
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MGJmNDA5YmE4MGM3NzgwZDY0In0.OkfLWyw5Oh5e9AhTQXb9jGNYI3CP_yoREDKokNICadroa8r8e6kf6cRV5mL9UTxwwiap0y639rZDodaIRxdnwg

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "renter": {
    }
}

Reports

Show kkt info by days

Получение информации по кассе ТЦ за период времени

path Parameters
sc_id
string
Example: 6a05670bf409ba80c7780d73
kkt_id
string
Example: 6a05670bf409ba80c7780d85
query Parameters
start_date
required
date
Example: start_date=2024-01-01
end_date
required
date
Example: end_date=2024-03-01
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MGJmNDA5YmE4MGM3NzgwZDhhIn0.u8a2yrFfVsfFdXzAUzWoBGfPjBPQltiPjppZbQEerQwXAMG2IrKresa7kRLM27F7tjOFXrVkLfwImasxjnYlwA

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "data": [
    ]
}

Show shop info by days

Получение информации по торговой точке ТЦ за период времени

path Parameters
sc_id
string
Example: 6a05670df409ba80c7780e09
shop_id
string
Example: 6a05670df409ba80c7780e0c
query Parameters
start_date
required
date
Example: start_date=2024-01-01
end_date
required
date
Example: end_date=2024-03-01
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MGRmNDA5YmE4MGM3NzgwZTI2In0.vW2VFipPsGqDYbC6VG6D0AGpva0GaT77GFuo-H4UnHSqPF9281JRnf-IQkO6ySJyQkFhvQPWfWwkKrj5ir-zVQ

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "data": [
    ]
}

Show shops' info

Получение информации по магазинам ТЦ за период времени

path Parameters
sc_id
string
Example: 6a056710f409ba80c7780ee2
query Parameters
start_date
required
date
Example: start_date=2024-01-01
end_date
required
date
Example: end_date=2024-03-01
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MTBmNDA5YmE4MGM3NzgwZjBjIn0.jG2NnJR73bVJSPznwmcrJ46cik3l3IhDPEhv__UdcvE4WlK0QDPq7wzDbh7gB91nHVyAbxppNx20Ddyzz7UcRQ

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "shops": [
    ]
}

Show shop info by receipts

Получение информации по чекам торговой точки ТЦ за период времени

path Parameters
sc_id
string
Example: 6a056712f409ba80c7780fbe
shop_id
string
Example: 6a056712f409ba80c7780fc1
query Parameters
start_created_date
date
Example: start_created_date=2025-01-01

Начальная дата фильтрации по дате создания. Обязателен при передаче end_created_date

end_created_date
date
Example: end_created_date=2025-03-01

Конечная дата фильтрации по дате создания. Обязателен при передаче start_created_date

start_received_date
date
Example: start_received_date=2025-04-01

Начальная дата фильтрации по дате поступления. Обязателен при передаче end_received_date

end_received_date
date
Example: end_received_date=2025-05-01

Конечная дата фильтрации по дате поступления. Обязателен при передаче start_received_date

header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MTNmNDA5YmE4MGM3NzgwZmRiIn0.4W9NkpuDi5OXkBKoJ1wI9OHzDC_9c01BO2UvA9CZamHT2kMPMCfH-7oJPx9aBkNPYtIoQGmDVMpqzKZ1xJoA7Q

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "receipts": [
    ]
}

Rkeepers

Create rkeeper check

Создание rkeeper чека

path Parameters
sc_id
string
Example: 6a056717f409ba80c77810f4
sell_location_id
string
Example: 6a056717f409ba80c77810f7
header Parameters
Accept
any
Example: application/json
api-token
any
Example: $2a$04$z1hWqMIH/5sWC2LKMyns0O7HJmP5A5Mrb2puRuy31Vl1WWKDKkd3O
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true
}

Get last sale date

Получение даты последнего чека

path Parameters
sc_id
string
Example: 6a056718f409ba80c778114e
sell_location_id
string
Example: 6a056718f409ba80c7781151
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: $2a$04$h40Nk13CxOus5cLvNx97cO8AwO3VAQRH4iQcKamsGW9mmPxjMWjQq

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "last_sale_date": "2026-05-14"
}

Sensors

Create sensor traffic

Создание записи о посещаемости по датчику за час

path Parameters
sc_id
string
Example: 6a056719f409ba80c7781187
header Parameters
Accept
any
Example: application/json
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MTlmNDA5YmE4MGM3NzgxMThkIn0.N9YhRQl_VByf-8R0yRYwQMkW-yIQx5HhHZ5Ff7rhpLSAonUR83-16oELjKqtwmFhoLTrWTUPrP106lB2HcHPYQ
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
Example
{
  • "external_id": "1e35e179-2d4b-40b5-a404-86a6e2744ac2",
  • "data": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "created": [
    ]
}

Show sensors' list

Получение списка датчиков по ТЦ

path Parameters
sc_id
string
Example: 6a05671cf409ba80c77811ac
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWNmNDA5YmE4MGM3NzgxMWIzIn0.hsYiBzJLXdx70gUorW1gg4Aknrit_CjyFV0AXNHMIIezwHhhtSeMKnY9OEPOQtAjqaSEcjlSLIeHp9lwMSugyA

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "sensors": [
    ]
}

ShoppingCenters

Show shopping centers

Получение информации по всем ТЦ

header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWNmNDA5YmE4MGM3NzgxMWNjIn0.grHkyc8-OZ5ElbxjfK9M53sZ-bFacyQYdXmmZr1bBtuG0j0AgTHXLFDd3eJtVVA20B7gmp7e16uHZgvHKzRYEA

Responses

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "success": true,
  • "shopping_centers": [
    ]
}

Show shopping center

Получение информации по ТЦ

path Parameters
id
string
Example: 6a05671cf409ba80c77811dc
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWNmNDA5YmE4MGM3NzgxMWUwIn0.Y-ZGsxvSdVQf4ttnP_ByPmtohYcpQRH1f_HRCD2UEbknJmqpNVFxg0At-6wFH2AryD0aIGEBrkGe-GP7g0KD1Q

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "shopping_center": {
    }
}

Sell locations

Show sell_locations' list

Получение списка торговых точек ТЦ

path Parameters
sc_id
string
Example: 6a05671df409ba80c77811e8
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWRmNDA5YmE4MGM3NzgxMjA2In0.mfQFIBDjqgnSh1OhRE-s5brpLeXFw3QViwBiWIRK8T3nejw8c279kbhTEIlXJZA5xmFUZtonRYNGuQr2XLD3Pg

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "shops": [
    ]
}

TrafficAreas

Create traffic data by area per day

Создание записи о посещаемости по зоне за день

path Parameters
sc_id
string
Example: 6a05671df409ba80c778120e
header Parameters
Accept
any
Example: application/json
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWRmNDA5YmE4MGM3NzgxMjEzIn0.76nqP9mBIwziiiP02r71jqw9JuyIr2DRaKPSA2_tGh_3KGqwZPk7EyLMiEcgsNLDVlv9zRzdofTb_z39E8OElQ
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
Example
{
  • "manual_value": 4161,
  • "traffic_area_id": 14,
  • "date": "2026-05-14"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "manual_sensor_traffic": {
    }
}

Show traffic areas list

Получение списка зон по ТЦ

path Parameters
sc_id
string
Example: 6a05671ef409ba80c7781235
header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWVmNDA5YmE4MGM3NzgxMjNhIn0.QdyPIUHVhT6N3ujChWK6jBmWtkLQPHzlVC88GL-3UI-eKz80CeENuYHUYnqJ27Q8XcuBe2G6tbwyOKypQ4jXBA

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "traffic_areas": [
    ]
}

Turnovers

Create manual turnover data

Добавление информации о месячных показателях товарооборота

path Parameters
sc_id
string
Example: 6a05671ff409ba80c7781247
shop_id
string
Example: 6a05671ff409ba80c778124a
query Parameters
date
required
date
Example: date=2024-01-01
manual_turnover_sum
required
integer
Example: manual_turnover_sum=100000
manual_receipts_count
integer
Example: manual_receipts_count=100
manual_visitors_count
integer
Example: manual_visitors_count=100
manual_vat_sum
integer
Example: manual_vat_sum=100
manual_income_without_vat
integer
Example: manual_income_without_vat=100
manual_income_with_vat
integer
Example: manual_income_with_vat=100
header Parameters
Accept
any
Example: application/json
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MWZmNDA5YmE4MGM3NzgxMjU4In0.MdbWjrbO9bf38AHrYgCXi6NsXu2XRqZfBO7Yoqy9gQDhYHoGWXW3_rxh1h9TKnHrqI8w5LidYvyGmVNKGKHZLg
Content-Type
any
Example: application/json
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
Example
{
  • "manual_turnover_sum": 745,
  • "manual_receipts_count": 48,
  • "manual_visitors_count": 50,
  • "manual_income_with_vat": 549,
  • "manual_income_without_vat": 415,
  • "manual_vat_sum": 806,
  • "date": "2026-05-01"
}

Response samples

Content type
application/json; charset=utf-8
Example
{
  • "success": true
}

Weather

Get weather by period

Получение информации о погоде в городе торгового центра за указанный период

path Parameters
id
string
Example: 6a056721f409ba80c77812d2
query Parameters
start_date
required
string
Example: start_date=2024-01-01

Начальная дата периода (формат YYYY-MM-DD)

end_date
required
string
Example: end_date=2024-01-31

Конечная дата периода (формат YYYY-MM-DD)

header Parameters
Accept
any
Example: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
api-token
any
Example: eyJhbGciOiJIUzUxMiJ9.eyJ1dWlkIjoiNmEwNTY3MjFmNDA5YmE4MGM3NzgxMmQ3In0.0au4Pse73SzJlB_liYckcp8MmflCE6sAeGguNC1AHiuXyAbmdNA6IwGDC_qQqUiBVy3BQdOr2tAcDmFHrVEH1Q

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "success": true,
  • "days": [
    ]
}