Header - AP-Device-Identifier
- Topics:
- Authentication
NOTEOverview
The AP-Device-Identifier request header contains the streaming device identifier as it was created by the client application.
Syntax
| AP-Device-Identifier: <type> <identifier> | |
| Header Type | Request header |
| Standard | No |
Directives
<type>
The device identifier type.
There is only one supported types as presented below.
| Type | |
|---|---|
| fingerprint | The device identifier consists of a stable and unique identifier created and managed by the client application for each device. The client application should cache the device identifier in persistent storage, as losing or altering it will invalidate authentication. The client application should prevent value changes caused by user actions such as application uninstallation, re-installation, or upgrades. |
<identifier>
The Base64-encoded value of the device identifier.
Example
// device identifier
// ba23d141-d715-561c-94f4-e9e4c966b1eb
// Base64-encoded
// YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
Cookbooks
IMPORTANTAP-Device-Identifier header must contain a value formated as described in the Directives section.Browsers
To build the AP-Device-Identifier header for devices running in a browser, your client application requires to compute a stable and unique identifier based on available data such as browser, device, or user specific data.
(*) We recommend to integrate a library or service that provides a browser or device fingerprinting mechanism.
Mobile Devices
iOS & iPadOS
To build the AP-Device-Identifier header for devices running iOS or iPadOS, you may refer to the following documents:
- Apple developer documentation for identifierForVendor.
(*) We recommend to apply an SHA-256 hash function over the OS provided value.
Android
To build the AP-Device-Identifier header for devices running Android, you may refer to the following documents:
- Android developer documentation for ANDROID_ID.
(*) We recommend to apply an SHA-256 hash function over the OS provided value.
TV Connected Devices
tvOS
To build the AP-Device-Identifier header for devices running tvOS, you may refer to the following documents:
- Apple developer documentation for identifierForVendor.
(*) We recommend to apply an SHA-256 hash function over the OS provided value.
Fire OS
To build the AP-Device-Identifier header for devices running Fire OS, you may refer to the following documents:
- Android developer documentation for ANDROID_ID.
(*) We recommend to apply an SHA-256 hash function over the OS provided value.
Roku OS
To build the AP-Device-Identifier header for devices running Roku OS, you may refer to the following documents:
- Roku developer documentation for GetChannelClientId.
(*) We recommend to apply an SHA-256 hash function over the OS provided value.
Others
For device platforms not covered in the documentation, the device identifier should be linked to any available hardware identification, typically specified in the device’s hardware manual.
If no hardware identifiers are available, a uniquely generated identifier based on client application attributes should be used and cached in persistent storage.