Wanfu Customer Traffic Cloud Platform Open API Guide: Integrate customer traffic, vehicle volume, queue length, and heat map data into your own system.
All standard APIs are authenticated via the X-API-Key header; no additional API key retrieval is required.
X-API-Key: wf_live_xxxxxxxxxxxxxxxx
Request Header Example
curl -X POST https://{API_HOST}/wanf-api/people-counting-data/ \
-H "X-API-Key: wf_live_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"types": 1,
"site": [53, 63],
"size": "day",
"index": ["enter", "exits"],
"date": "2023-04-01 - 2023-04-03"
}'{API_HOST} is the platform domain assigned after activating the service.
Log in to the cloud platform admin console, navigate to the "My API Keys" page, and click "Create Key" to generate a new API key.
Each key is bound to a top-level organization. Select the target organization during creation. Save the key securely after creation, as the system will not display the full key again.
To reset or rotate your API key, log in to the cloud platform management console, navigate to the "My API Keys" page, locate the relevant key, and click the "Reset" button.
Old keys expire immediately after reset. Update your code with the new key.
/wanf-api/get-site/?level=2&pk=0If pk equals 0, return all venues under the current user's organization whose level matches the level value; otherwise, return all descendant organizations of the organization with id equal to pk and level matching the level value.
PS: Providing invalid values or lacking permissions will return an empty organization list or a 400 response.
/wanf-api/people-counting-data/Authentication: X-API-Key required. Anonymous access is denied. Body parameters support form or JSON submission.
Note: If the camera does not support this query metric, the retrieved data will be 0.
/wanf-api/vehicle-real-data/?date=2024-03-23&site=85&page_size=1000Note: An empty list or error response will be returned if an invalid value is provided or you lack permission. Due to the large data volume, daily request limits are set to 100.
/wanf-api/vehicle-counting-data/Authentication: X-API-Key required. Anonymous access is denied. Body parameters support form or JSON submission.
PS: In the return example, the `annotates` field contains statistical results for the time range [11, 18]. 11 represents the corresponding group ID from the grouping conditions (e.g., "Dump Truck - Muck Truck" in the example above), and 18 indicates the vehicle count. When grouping by license plate, the date range must not exceed 1 days.
/wanf-api/parking-spaces-data/Authentication: X-API-Key required. Anonymous access is denied. Body parameters support form or JSON submission.
Note: Up (3) indicates departure, Down (4) indicates arrival; Remaining spaces = Total parking spots - (Arrivals - Departures), minimum 0.
/wanf-api/person-queue-timing/The Body parameter supports form or JSON submissions.
Return structure: `code` is the status code (success 1, error 2); `msn` contains a "Device ID" object, which holds an array of "Time Period Data". Each time period data entry includes an array of "Region Statistics" structured as [region ID, total visitors for that period, average dwell time, [[dwell time tier 1, count], [dwell time tier 2, count]]]. Dwell time tiers are configured in the camera and support up to 4 tiers.
/wanf-api/person-queue-area/?sn=e8:a0:ed:00:fa:ce&ruleid=1Note: Providing invalid values or lacking permissions will return an empty list or an error response.
/wanf-api/queue-realtime-data/Authentication: X-API-Key required. Anonymous access is denied. Body parameters support form or JSON submission.
Note: peopleNum is the current number of people in the area, waitTime is the estimated queue time in seconds, waitTimeMin is the duration in minutes, saturation is the occupancy percentage, and comfort indicates the crowding level (Comfortable / Moderate / Crowded / Saturated).
/wanf-api/heatmap-overlay/Authentication: X-API-Key required. Anonymous access is denied. Body parameters support form or JSON submission.
Note: An error response will be returned if an invalid value is provided or permissions are missing. image_base64 represents the Base64-encoded PNG data of the composite image.
/wanf-api/sales-data-push/Authentication: X-API-Key required. Anonymous access is denied. Body parameters support form or JSON submission.
Retrieves the optional metrics for the customer traffic data API index, grouped by capability.
Note: If the camera does not support this query metric, the retrieved data will be 0.
Push transaction counts and amounts via the sales data push interface to calculate store conversion rate and average order value alongside foot traffic data on the same screen.
/wanf-api/sales-data-push/Pull heatmap composite images and real-time queue data to embed into your own dashboard, displaying area saturation levels and comfort ratings.
/wanf-api/heatmap-overlay/Query real-time queue counts, estimated wait times, and saturation levels by location to proactively redirect traffic via announcements and guidance screens.
/wanf-api/queue-realtime-data/Get remaining parking spaces and traffic flow statistics by vehicle type, lane, direction, or zone to support entry/exit scheduling.
/wanf-api/parking-spaces-data/Important Notice: All endpoints are protected by unified rate limiting; anonymous access is denied. The X-API-Key request enforces rate limits based on the organization's subscription plan associated with the key. The default configuration is 20 requests per minute and 1000 requests per day. Actual limits are determined by your organization's current subscription plan or independent API Key settings.
Leave your contact details. A technical consultant will assist you with the API Key application and integration.
Fill in your information. A technical consultant will contact you within 1 business days and provide a free device compatibility check.