Authentication
All Pulses API calls require a ChannelKey — an API key that identifies your integration channel.
Getting Your ChannelKey
Your ChannelKey is provided when you register a channel with Pulses. Contact your Pulses account manager to obtain sandbox credentials.
Using the ChannelKey
Include the ChannelKey header in every API request:
curl -X GET "https://platform.pulses.ai/Pulses/Gateway/Locations" \
-H "ChannelKey: YOUR_CHANNEL_KEY" \
-H "TransactionId: $(uuidgen)"
Required Headers
| Header | Type | Required | Description |
|---|---|---|---|
ChannelKey | string | Yes | Your API key |
TransactionId | UUID | Yes | Unique ID per request (for tracing) |
Sandbox vs. Production
- Sandbox:
platform-gwc.pulses.ai(Gateway Client) andplatform.pulses.ai(Gateway) - Production: Same API format, different base URLs (provided by Pulses)
Sandbox keys only work against sandbox endpoints. They cannot access production data.