FootfallCam 3D Plus User Manual

Hide thumbs Also See for 3D Plus:

Advertisement

Quick Links

USER MANUAL
For FootfallCam 3D Plus
www.footfallcam.com
API Documentation
1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the 3D Plus and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for FootfallCam 3D Plus

  • Page 1 USER MANUAL For FootfallCam 3D Plus www.footfallcam.com API Documentation...
  • Page 2: Table Of Contents

    2.0 Export Footfall Data to Retailer System 2.1 Pull Data via API 2.2 Pull Data from Central Database 2.3 Pull Data from FTP Server 2.4 Download CSV from FootfallCam Portal 3.0 Import Data from Retailer System 3.1 Push Data via API 3.1.1 ePOS Data 3.1.2 Staff Labour Hours...
  • Page 3: 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 hours (from retailer’s ePOS system or staff management system) to produce management report for corporate strategic planning.
  • Page 4 <typedesc> is description of count type, where 3 represent In, and 4 represent Out. Success Response (XML) <typedesc> <type typeid="3">Pedestrian coming in</type> <type typeid="4">Pedestrian going out</type> </typedesc> and <count set> is <cntset name="<Company Code> - <Counter Name>" starttime="<start time>" delta="<delta>"> <count group> </cntset> www.footfallcam.com API Documentation...
  • Page 5: Pull Data From Central Database

    2.2 Pull Data from Central Database Instead of using API, users may choose to extract the footfall data directly from FootfallCam Central Database. This involves establishing a remote connection directly to the database to extract the data from the relevant table to the business intelligence system.
  • Page 6 Counting data include Counter (in hourly interval), ValueDateTime, ValueIn, ValueOut, OutsideTraffic, Day, CounterId Function Name GetCounterCounting Method Username [nvarchar] Password [nvarchar] Data Params CounterId [bigint] StartDate [datetime] EndDate [datetime] Success Response SELECT FROM GetCounterCounting('username', 'password', 410, '2015-03-20 00:00:00', '2015-03-20 Sample Call 23:59:59'); Notes None www.footfallcam.com API Documentation...
  • Page 7 A dedicated FTP server will be provided by retailer as a ‘shared folder’ where access (link, username and password) will be given to FootfallCam technical team to dump the footfall data (.csv files) into it. These data will then being retrieved from the FTP Server to the business intelligence system for further data processing to generate the management report.
  • Page 8: Download Csv From Footfallcam Portal

    Through an API call, retailer system sends a http request (containing ePOS data, staff labour hours, etc.) to FootfallCam central server. FootfallCam central server returns a status to retailer’s system, indicating if the request is successful or fail. The data received from retailer’s system will be further processed to integrate with the footfall data and generate reports in FootfallCam portal.
  • Page 9 SecretKey : [String] Secret key provided by footfallcam for authentication purpose. Data: Array of data entries as below: Timestamp : [long] Timestamp for every 15 minutes TransactionCount : [int] Numbers of transaction withinin 15 minutes AverageAmount : [double] Average amount of transaction within 15 minutes Example: SecretKey : “0E6A48F765D0FFFFF6247FA80D748E615F91DD0C7431E4D9”,...
  • Page 10: Staff Labour Hours

    Method POST URL Params None SecretKey : [String] Secret key provided by footfallcam for authentication purpose. Data: Array of data entries as below: Timestamp : [long] Timestamp for every 15 minutes StaffCount : [int] Numbers of Staff withinin 15 minutes Example: SecretKey : “0E6A48F765D0FFFFF6247FA80D748E615F91DD0C7431E4D9”,...
  • Page 11: Push Data To Ftp Server

    3.2 Push Data to FTP Server A dedicated FTP server will be provided by FootfallCam as a ‘shared folder’ where access (link, username and password) will be given for retailer to dump the ePOS data, staff labour hours, etc. into it. These data will then being retrieved, further processed to integrate with the footfall data and generate reports in FootfallCam portal.

Table of Contents