Quick Start
Get from zero to your first API call in under 5 minutes.
Prerequisites
- A Pulses sandbox ChannelKey (see Authentication)
- Any HTTP client (curl, Postman, or your language's HTTP library)
Step 1: Verify Your Key
curl -s "https://dewa.pulses.ai/Pulses/Gateway/Locations" \
-H "ChannelKey: YOUR_CHANNEL_KEY" \
-H "TransactionId: $(uuidgen)" | jq .
If your key is valid, you'll get a JSON array of locations.
Step 2: Try the Simulator
Head to the Simulator for an interactive walkthrough of the full face recognition pipeline:
- Browse Infrastructure — see your locations, zones, and cameras
- Enroll a Face — upload a photo to register a person
- Simulate Detection — trigger a camera to "detect" the enrolled face
- Lookup Customer — retrieve the person's details by Face ID
Step 3: Explore the API Reference
- Gateway Client API — enrollment, verification, customer lookup
- Gateway API — locations, zones, cameras, visitors
Step 4: Grab Starter Code
Copy working examples in your language: