Header - AP-Device-Identifier header-ap-device-identifier

NOTE
The content on this page is provided for information purposes only. Usage of this API requires a current license from Adobe. No unauthorized use is permitted.

Overview overview

The AP-Device-Identifier request header contains the streaming device identifier as it was created by the client application.

Syntax syntax

AP-Device-Identifier: <type> <identifier>
Header Type
Request header
Standard
No

Directives 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.
The client application must prevent value changes caused by user actions such as application uninstall, re-install, or upgrades.

<identifier>

The Base64-encoded value of the device identifier.

Example example

// device identifier
// ba23d141-d715-561c-94f4-e9e4c966b1eb

// Base64-encoded
// YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi

AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi

Cookbooks cookbooks

IMPORTANT
The documentation resources are provided for referencing purposes.
The documentation resources are not exhaustive and may require additional modifications to work in your project.
Regardless of your actual implementation, the AP-Device-Identifier header must contain a value formated as described in the Directives section.

Browsers 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 mobile-devices

iOS & iPadOS ios-ipados

To build the AP-Device-Identifier header for devices running iOS or iPadOS, you may refer to the following documents:

(*) We recommend to apply an SHA-256 hash function over the OS provided value.

Android android

To build the AP-Device-Identifier header for devices running Android, you may refer to the following documents:

(*) We recommend to apply an SHA-256 hash function over the OS provided value.

TV Connected Devices tv-connected-devices

tvOS tvos

To build the AP-Device-Identifier header for devices running tvOS, you may refer to the following documents:

(*) We recommend to apply an SHA-256 hash function over the OS provided value.

Fire OS fireos

To build the AP-Device-Identifier header for devices running Fire OS, you may refer to the following documents:

(*) We recommend to apply an SHA-256 hash function over the OS provided value.

Roku OS rokuos

To build the AP-Device-Identifier header for devices running Roku OS, you may refer to the following documents:

(*) We recommend to apply an SHA-256 hash function over the OS provided value.

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b