FootfallCam 3D Plus Operator's manual

F100327-04 API Documentation
1
F100327-04

F100327-04 API Documentation
2
Revision History
Revision Number
Description of Revision
Date of Revision
1
Initial Draft
November, 14 2016
2
Revision
August, 01 2017
3
Updated Protocol for Counting Data Retrieval
September, 06 2017
4
Updated Minimum Server Requirement
November, 15 2017
C1
C2
C3
C4
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
International Inc.
Copyright© 2002-2017, FootfallCam
Information Classification
This document is classified as Public Information.

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

F100327-04 API Documentation
4
1.0 Overview
FootfallCamis a fullyembedded softwaremodule, intendedforanyenvironment wherestorefootfall countingisrequired.Businessintelligence
(BI) system extracts and analyses footfall data (from FootfallCam central server) together with ePOS data or staff labour hours (from retailer’s
ePOSsystem or staff managementsystem) to producemanagement report for corporate strategic planning.
There are several waysof integrating footfall data with theePOS data or staff labour hours:
•Exportfootfalldata toretailersystem
•ImportePOSdataor stafflabourhoursto FootfallCam centralserver

F100327-04 API Documentation
5
2.0 Authentication API
Generate new API access token by usernameand password
Sample Call: http://<ip>:<port>/cgi-bin/access_token.cgi?username=yourusername&password=yourpassword
Sample Respond:
Note:Theaccesstokendoesnothaveanyexpirydate,itsvaryfromusernameandpassword.Kindlyre-obtainthe accesstokenonceusername
and password changed.

F100327-04 API Documentation
6
3.0 Export Footfall Data to Retailer System
3.1 PullData via API from counter
The camera automaticallycollects the traffic data and builds them into a convenient JSON/XML data file that can be retrieved easily via a web
serviceAPIcall, henceallowingseamless integrationofthecameraintoanyexistingsolution.ThroughanAPIcall, thedatafile willbeextracted
from FootfallCam portal to the business intelligence system for further data processing in ordertogenerate themanagement report.
3.1.1 Counter API Terminology and Parameters
Forcounter data weuse following terminology and parameters:
Parameter
Default
Description
Value
Sample
data_type
json
Type of the data
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 data
YYYYMMDD
date_end=20190228
resolution_min
1
The minutes data’s
resolution (Minutes data
only)
1, 5, 10, 15, 30, 60
resolution_min=15
resolution_sec
10
The second data’s
resolution (Only available
for counter running firmware
version 3.2.0)
1, 5, 10, 15, 30, 60
resolution_sec=1
time_start
1 day [0:00]
To set the start time range
of the API
HHmmss
time_start=103000
time_end
1 day [23:59]
To set the end time range of
the API
HHmmss
time_end=223300
Note:
Themaximum amount of data you can get from time range is 24 hours. Both time range start and end should be set.
- time_start is set, but time_end is not= default time_end will be 1 hour after time_start
- time_endis set, but time_start is not = default time_start will be “000000”

F100327-04 API Documentation
7
3.1.2 GetCounting Data in second for selected dateand time range
Description
Title
Get Counting Data in second for selected date and time range
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?date_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
Single day - <YYYYMMDD>
Omit
Date range - <YYYYMMDD>
Omit
Time range - <HHmmss>
omit –The current day data
Single day –Data on the
specified day
omit –The start date –The end
date
omit –The start time –The end
time
Success
Response
(Json)
URL(xml)
http://<ip>:<port>/cgi-bin/apiCount.cgi?date_start=20171120&date_end=20171129&data_type=xml&&data_format=hour&access_token=token

F100327-04 API Documentation
8
Success
Response
(xml)
Note
Iftime rangeisselected, youcanmaximumlyselectoneday data perrequest
Note:
Retrieving data inseconds resolution from the FootfallCam counter level is onlyusable by countersonfirmware v.3.2.0 and
later.

F100327-04 API Documentation
9
3.1.3 Get Counting Data in minute for selected date
Description
Title
Get Counting Data in minute for selected date
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
GET
URL Parameters
Optional: -
Name
Value
Descriptions
Date
omit
Single day - <YYYYMMDD>
omit –The current day data
Single day –Data on the
specified day
Success Response
(Json)
URL(xml)
http://<ip>:<port>/cgi-
bin/apiCount.cgi?date_start=20171118&data_type=xml&resolution_min=30&data_format=minute&access_token=token

F100327-04 API Documentation
10
Success Response (xml)
Note
Youcanonlyobtainone-dayminutedataperrequest

F100327-04 API Documentation
11
3.1.4 GetCounting Data in hour for selected date
Description
Title
Get Counting Data in hour for selected date
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
GET
URL Parameters
Optional: -
Name
Value
Descriptions
Date
omit
Single day - <YYYYMMDD>
Omit
Date range - <YYYYMMDD>
omit –The current day data
Single day –Data on the
specified day
omit –The start date –The end
date
Success Response
(Json)
URL(xml)
http://<ip>:<port>/cgi-
bin/apiCount.cgi?date_start=20171120&date_end=20171129&data_type=xml&&data_format=hour&access_token=token

F100327-04 API Documentation
12
Success Response (xml)
Note
Youcanchoosetoobtainsingledayordaterange

F100327-04 API Documentation
13
3.2 Pull Data from SQL in CentralDatabase
Instead of usingAPI, users maychoose to extract the footfall data directlyfrom FootfallCam Central Database. This involves establishinga remote connection
directly to the database to extract the datafrom the relevant table to the business intelligence system.
3.2.1 HowtoGetBranchList
Title
GetBranchList
Description:SQLFunctiontoretrievebranchlist.
BranchdataincludeBranchId,Name,Region,City,Country,StoreType,Latitude,LongitudeandFloorSize
FunctionName
GetBranchList
Method
SQL
DataParams
Username[nvarchar]
Password[nvarchar]
SuccessResponse
SampleCall
SELECT* FROMGetBranchList('username','password');
Notes
None
3.2.2 HowtoGetCounterList
Title
GetCounterbyBranch
Description:SQLFunctiontoretrievecountersfilteredbybranch.
CounterdataincludeCounterId,Name,IP,Port,Serial
FunctionName
GetCounterByBranch
Method
SQL
DataParams
Username[nvarchar]
Password[nvarchar]
BranchId[bigint]
SuccessResponse
SampleCall
SELECT*FROMGetCounterByBranch('username','password',37);

F100327-04 API Documentation
14
3.2.3 HowtoGetHourlyCounting DatabyBranch
Title
Getbranchhourlycountingdata
Description:SQLFunctiontoretrievecountingfilteredbycounter.
CountingdataincludeCounter(inhourlyinterval),ValueDateTime,ValueIn,ValueOut,OutsideTraffic,Day,CounterId
FunctionName
GetCounterCounting
Method
SQL
DataParams
Username[nvarchar]
Password[nvarchar]
BranchCode[bigint]/ “-1” for whole branch in company
StartDate[datetime]
EndDate[datetime]
SuccessResponse
SampleCall
SELECT*FROMGetBranchHourly('username','password',-1,'20150320','20150321');
Notes
-1refertotheallbranchesinthecompany
3.2.3 HowtoGetDailyCountingDatabyBranch
Title
GetBranchDailyCountingData
Description:SQLFunctiontoretrievedailysummaryfilteredbycounter
CountingdataincludeDate(POSIXTimestamp),CameraName,ValueIn,ValueOut,OutsideTraffic,TurnInRate,
LessThanFifteen,LessThanThiry,OverThirty,NewCustomer,ReturnInWeek,ReturnInMonth,AggreggationStatus.
VerificationStatus
FunctionName
GetBranchDailySummary
Method
SQL
DataParams
Username[nvarchar]
Password[nvarchar]
Branchcode[bigint]“-1” for whole branch in company
StartDate[datetime]
EndDate[datetime]
SuccessResponse
SampleCall
SELECT*FROMGetBranchDailySummary('username','password',410,‘20140120’, ‘20140121’);
Notes
-1refertotheallbranchesinthecompany