Различия
Здесь показаны различия между двумя версиями данной страницы.
| Следующая версия | Предыдущая версия | ||
|
doc:dev:api:visitorcounter [02.11.2016 19:00] rlysov создано |
doc:dev:api:visitorcounter [22.10.2025 12:12] (текущий) rlysov |
||
|---|---|---|---|
| Строка 3: | Строка 3: | ||
| В системе реализован программный интерфейс для добавления данных с внешних счетчиков посетителей. Эти данные могут быть использованы в отчетах VirtualPos, расчета конверсии и пр. | В системе реализован программный интерфейс для добавления данных с внешних счетчиков посетителей. Эти данные могут быть использованы в отчетах VirtualPos, расчета конверсии и пр. | ||
| - | Загруженные данные можно посмотреть в системе зайдя по прямой ссылке вида: http://mycompany.virtpos.ru/console/visitorCounter/ | + | Загруженные данные можно посмотреть в системе зайдя по прямой ссылке вида: https://[company].myvirtualpos.ru/console/visitorCounter/ |
| ===== Пример запроса на получение данных ===== | ===== Пример запроса на получение данных ===== | ||
| Строка 9: | Строка 9: | ||
| Пример запроса на добавление данных со счетчика посетителей: | Пример запроса на добавление данных со счетчика посетителей: | ||
| - | http://mycompany.virtpos.ru/api/visitorcounter/update?apikey=MySecret&warehouseid=1&date=2016-10-23&count_in=12&count_out=11 | + | https://[company].myvirtualpos.ru/api/visitorcounter/update?apikey=MySecret&warehouseid=1&date=2016-10-23&count_in=12&count_out=11 |
| ==== Параметры запроса на добавление данных ==== | ==== Параметры запроса на добавление данных ==== | ||
| + | Параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| + | |||
| + | * **date** (get only) - дата, за которую добавляются данные. Формат: ГГГГ-ММ-ДД ЧЧ:МН:СК | ||
| + | |||
| + | * **warehouse_id** (get only) - ID торговой точки, для которой добавляются данные со счетчиков | ||
| + | |||
| + | * **count_in** (get only) - количество вошедших человек | ||
| - | * **date** - дата, за которую добавляются данные. Формат: ГГГГ-ММ-ДД ЧЧ:МН:СК | + | * **count_out** (get only) - количество вышедших человек |
| - | * **warehouse_id** - ID торговой точки, для которой добавляются данные со счетчиков | ||
| - | * **count_in** - количество вошедших человек | + | ==== Ответ сервера ==== |
| - | * **count_out** - количество вышедших человек | + | В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info |
| + | В случае успешного ответа сервер также вернет **ID** записи и флаг **is_new**, который показывает была ли запись добавлена или обновлена. | ||