Subscribe to Our Youtube Channel
Related Manuals for FootfallCam 3D Plus
Summary of Contents for FootfallCam 3D Plus
- Page 1 F100327-04 API Documentation F100327-04...
-
Page 2: Revision History
Information Classification This document is classified as Public Information. This document contains confidential and propriety information belonging exclusively to FootfallCam International Inc. No confidential or propriety information contained in this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means electronic, mechanical, photocopied, recorded or otherwise without prior written permission of FootfallCam Copyright©... - Page 3 Table of Contents 1.0 Overview ............................4 2.0 Authentication API ..........................5 3.0 Export Footfall Data to Retailer System .................... 6 API Documentation F100327-04...
- Page 4 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 5 2.0 Authentication API Generate new API access token by 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 username and password. Kindly re-obtain the access token once username and password changed.
- Page 6 API call, hence allowing seamless integration of the camera into any existing solution. Through an API call, the data file will be extracted from FootfallCam portal to the business intelligence system for further data processing in order to generate the management report.
- Page 7 3.1.2 Get Counting Data in second for selected date and time range Description Get Counting Data in second for selected date and time range Title Description: API Function to receive counting data. Counting data includes Timestamp, number of In count, number of Out count http://<ip>:<port>/cgi- bin/apiCount.cgi?date_start=20180612&time_start=083000&time_end=183000&data_type=json&data_format=second&resolution_sec=30&access_to (Json)
- Page 8 (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 counters on firmware v.3.2.0 and later. API Documentation F100327-04...
- Page 9 3.1.3 Get Counting Data in minute for selected date Description Get Counting Data in minute for selected date Title Description: API Function to receive counting data. Counting data includes Timestamp, number of In count, 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 Optional: -...
- Page 10 Success Response (xml) Note You can only obtain one-day minute data per request API Documentation F100327-04...
- Page 11 3.1.4 Get Counting Data in hour for selected date Description Get Counting Data in hour for selected date Title Description: API Function to receive counting data. Counting data includes Timestamp, number of In count, number of Out count URL (Json) http://<ip>:<port>/cgi-bin/apiCount.cgi?data_type=json&&data_format=hour&access_token=token Method Optional: -...
- Page 12 Success Response (xml) Note You can choose to obtain single day or date range API Documentation F100327-04...
- Page 13 3.2 Pull Data from SQL in 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 14 3.2.3 How to Get Hourly Counting Data by Branch Get branch hourly counting data Title Description: SQL Function to retrieve counting filtered by counter. Counting data include Counter (in hourly interval), ValueDateTime, ValueIn, ValueOut, OutsideTraffic, Day, CounterId Function Name GetCounterCounting Method Username [nvarchar] Password [nvarchar]...
Need help?
Do you have a question about the 3D Plus and is the answer not in the manual?
Questions and answers