Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

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