FootfallCam 3D Plus Api Documentation Download Page 4

Page: 4 / 14

F100327-04

API Documentation

1.0 Overview

FootfallCam is a fully embedded software module, intended for any environment where store footfall

counting is required. Business intelligence

(BI) system extracts and analyses footfall data (from FootfallCam central server) together with ePOS data or staff labour hou

rs (from retailer’s

ePOS system or staff management system) to produce management report for corporate strategic planning.

There are several ways of integrating footfall data with the ePOS data or staff labour hours:

•

Export footfall data to retailer system

•

Import ePOS data or staff labour hours to FootfallCam central server

Summary of Contents for 3D Plus

Page 1: ...F100327 04 API Documentation 1 F100327 04...

Page 2: ...cument contains confidential and propriety information belonging exclusively to FootfallCam International Inc No confidential or propriety information contained in this publication may be reproduced s...

Page 3: ...F100327 04 API Documentation 3 Table of Contents 1 0 Overview 4 2 0 Authentication API 5 3 0 Export Footfall Data to Retailer System 6...

Page 4: ...es footfall data from FootfallCam central server together with ePOS data or staff labour hours from retailer s ePOS system or staff management system to produce management report for corporate strateg...

Page 5: ...username and password Sample Call http ip port cgi bin access_token cgi username yourusername password yourpassword Sample Respond Note The access token does not have any expiry date its vary from use...

Page 6: ...json xml data_type xml data_format Hour Format of the data hour minute second data_format second date_start Yesterday s date Start Date of the data YYYMMDD date_start 20181231 date_end End Date of the...

Page 7: ...ate_start 20180612 time_start 083000 time_end 183000 data_type json data_format second resolution_sec 30 access_to ken token Method GET URL Paramete rs Optional Name Value Descriptions Date Omit Singl...

Page 8: ...cess Response xml Note If time range is selected you can maximumly select one day data per request Note Retrieving data in seconds resolution from the FootfallCam counter level is only usable by count...

Page 9: ...ount number of Out count URL Json http ip port cgi bin apiCount cgi data_type json resolution_min 1 data_format minute access_token token Method GET URL Parameters Optional Name Value Descriptions Dat...

Page 10: ...F100327 04 API Documentation 10 Success Response xml Note You can only obtain one day minute data per request...

Page 11: ...ount URL Json http ip port cgi bin apiCount cgi data_type json data_format hour access_token token Method GET URL Parameters Optional Name Value Descriptions Date omit Single day YYYYMMDD Omit Date ra...

Page 12: ...F100327 04 API Documentation 12 Success Response xml Note You can choose to obtain single day or date range...

Page 13: ...anchlist Branch dataincludeBranchId Name Region City Country StoreType Latitude LongitudeandFloorSize Function Name GetBranchList Method SQL DataParams Username nvarchar Password nvarchar Success Resp...

Page 14: ...0 20150321 Notes 1 refertotheall branches inthecompany 3 2 3 How to Get Daily Counting Data by Branch Title Get BranchDaily Counting Data Description SQLFunctiontoretrievedailysummaryfilteredbycounter...