Token Creation

This authentication schema requires users to pass parameters inside the token together with corresponding query params within the API request.

Users must create a HMAC SHA-256 hash from the token string.

This Authentication schema should only be used on the Streaming API.

Authentication Schema

• Order of the fields is mandatory

• The separator between the fields is the character “:” (UTF-8 hex code 3A)

• HMAC-SHA256 should be used for encryption

Order	Field	Mandatory	Description	Example Value	Corresponding Query Parameter
1	url path	Yes	URL path	/api/v2/events/12345/stream
2	secret	Yes	Operator secret	S3CR3T!
3	timestamp	Yes	Number of milliseconds since the Unix epoch, i.e. number of milliseconds since midnight January 1st 1970, UTC.	1736870547919	timestamp=[timestamp]
4	location	No	Subdivision location An ISO-3166-2 US State or CA territory code	US-NY	location=[subdivision]

Example Request URLs and matching token strings

/api/v2/streaming/events/12345/stream?auth=XXX&timestamp=1736870495123&operatorId=1	/api/v2/streaming/events/12345/stream:SECRET:1736870495123
/api/v2/streaming/events/12345/stream?auth=XXX&timestamp=1736870495123&operatorId=1&location=US-NY	/api/v2/streaming/events/123/stream:SECRET:1736870495123:US-NY