Skip to main content
POST
Generate BMP sensor

Authorizations

X-Api-Key
string
header
required

Issued from the Roolink dashboard. Treat like a password.

Body

application/json
app
string
required

The app key for the target app. Required on every request.

Minimum string length: 1
proxy
string
required

Proxy the session will use, as scheme://[user:pass@]host:port. Send the same one on every request for this device.

Minimum string length: 1
Example:

"http://user:pass@proxy.example.com:8080"

language
string
default:en-US

Language and region for the device, such as en-US. Defaults to en-US.

Pattern: ^[a-z]{2}-[A-Z]{2}$
Example:

"en-US"

android
boolean
default:false

If true, generate an Android sensor. Otherwise iOS.

ipad
boolean
default:false

For iOS only — if true, emulate an iPad. Ignored when android: true.

deviceId
string

The deviceId from an earlier response, to continue that device. Omit on the first call.

Example:

"9F1A2B3C-4D5E-6F7A-8B9C-0D1E2F3A4B5C"

Response

Sensor generated.

sensor
string
required

Signed BMP sensor payload. Send it in the target request's X-acf-sensor-data header.

platform
enum<string>
required
Available options:
android,
ios
Allowed value: "android"
deviceId
string
required

Identifier of the generated device. Pass it back to continue the same device.

appVersion
string
required

App version the device reports.

screenHeight
integer
required

Screen height configured for the emulated device.

screenWidth
integer
required

Screen width configured for the emulated device.

language
string
required

Device language. Android returns the language only, such as en; iOS returns the full value, such as en-US.

cookies
object[]
required

Cookies the SDK collected. Seed them into your client.

android
string
required

Android OS release (e.g. 13).

Example:

"13"

deviceModel
string
required

Android model name configured for the emulated device.

Example:

"Pixel 7"

deviceManufacturer
string
required

Android manufacturer configured for the emulated device.

Example:

"Google"

appVersionCode
integer
required

Android versionCode integer.

sdkVersion
string
required

Akamai SDK version baked into the fingerprint.