Akamai BMP in Python: Send x-acf-sensor-data With Your App Requests

# akamai-bmp-python.py - generate the Akamai BMP header and send it with the app API request.
# Install: pip install requests
# Run: python akamai-bmp-python.py

import os
import time

import requests


# Your SurSolver API key.
CLIENT_KEY = "YOUR_API_KEY"
# The SDK version packaged by SurSolver (currently 4.2.1).
BMP_VERSION = "4.2.1"
# The Android package name of the app.
APP_PACKAGE = "com.example.app"
# The versionName of the app.
APP_VERSION = "1.2.3"
# The versionCode of the app.
APP_VERSION_CODE = 123
# The protected API URL configured in the Akamai SDK.
SDK_SERVER_URL = "https://api.example.com"
# The app's protected API request URL.
APP_API_URL = "https://example.com/app-api"
# Its HTTP method; GET when unset.
APP_API_METHOD = None
# File that keeps the device id between runs; device-id.txt when unset.
DEVICE_ID_FILE = None
# Text that appears only in a response the site accepted.
SUCCESS_TEXT = "PASTE_ACCEPTED_MARKER"


API = "https://api.sursolver.com"
POLL_ATTEMPTS = 60


def call(path, body):
    # API errors are HTTP 200 with errorId 1; anything else is a transport failure.
    response = requests.post(f"{API}{path}", json=body, timeout=30)
    response.raise_for_status()
    data = response.json()
    if data["errorId"] != 0:
        raise RuntimeError(f'{data["errorCode"]}: {data["errorDescription"]}')
    return data


def solve(task):
    created = call("/createTask", {"clientKey": CLIENT_KEY, "task": task})
    for _ in range(POLL_ATTEMPTS):
        result = call("/getTaskResult", {"clientKey": CLIENT_KEY, "taskId": created["taskId"]})
        if result["status"] == "ready":
            return result["solution"]
        time.sleep(3)
    raise TimeoutError(f'task {created["taskId"]} was not ready in {POLL_ATTEMPTS} polls')


def without_empty(fields):
    # Optional task fields are sent only when they have a value.
    return {name: value for name, value in fields.items() if value not in (None, "")}


def main():
    device_file = DEVICE_ID_FILE or "device-id.txt"
    # One installation keeps one device id; reuse the id a previous run saved.
    device_id = None
    if os.path.exists(device_file):
        with open(device_file, encoding="utf-8") as handle:
            device_id = handle.read().strip()

    solution = solve({
        "type": "AkamaiBmpTask",
        "version": BMP_VERSION,
        "appPackage": APP_PACKAGE,
        "appVersion": APP_VERSION,
        "appVersionCode": APP_VERSION_CODE,
        "serverURL": SDK_SERVER_URL,
        **without_empty({"deviceId": device_id}),
    })
    with open(device_file, "w", encoding="utf-8") as handle:
        handle.write(solution["deviceId"])

    headers = {"x-acf-sensor-data": solution["header"]}
    # Add the headers and body the app sends with this request.
    response = requests.request(APP_API_METHOD or "GET", APP_API_URL, headers=headers, timeout=30)
    if not response.ok or SUCCESS_TEXT not in response.text:
        raise SystemExit(f"The site did not accept the result (HTTP {response.status_code}).")
    print("The site accepted the result.")


if __name__ == "__main__":
    main()

// akamai-bmp-node.js - generate the Akamai BMP header and send it with the app API request.
// Install: Node.js 18 or newer (no packages).
// Run: node akamai-bmp-node.js

const fs = require('node:fs');
const { setTimeout: sleep } = require('node:timers/promises');

// Your SurSolver API key.
const CLIENT_KEY = 'YOUR_API_KEY';
// The SDK version packaged by SurSolver (currently 4.2.1).
const BMP_VERSION = '4.2.1';
// The Android package name of the app.
const APP_PACKAGE = 'com.example.app';
// The versionName of the app.
const APP_VERSION = '1.2.3';
// The versionCode of the app.
const APP_VERSION_CODE = 123;
// The protected API URL configured in the Akamai SDK.
const SDK_SERVER_URL = 'https://api.example.com';
// The app's protected API request URL.
const APP_API_URL = 'https://example.com/app-api';
// Its HTTP method; GET when unset.
const APP_API_METHOD = '';
// File that keeps the device id between runs; device-id.txt when unset.
const DEVICE_ID_FILE = '';
// Text that appears only in a response the site accepted.
const SUCCESS_TEXT = 'PASTE_ACCEPTED_MARKER';

const API = 'https://api.sursolver.com';
const POLL_ATTEMPTS = 60;

// API errors are HTTP 200 with errorId 1; anything else is a transport failure.
async function call(path, body) {
  const res = await fetch(`${API}${path}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(body),
  });
  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  const data = await res.json();
  if (data.errorId !== 0) throw new Error(`${data.errorCode}: ${data.errorDescription}`);
  return data;
}

async function solve(task) {
  const created = await call('/createTask', { clientKey: CLIENT_KEY, task });

  for (let attempt = 0; attempt < POLL_ATTEMPTS; attempt += 1) {
    const result = await call('/getTaskResult', {
      clientKey: CLIENT_KEY,
      taskId: created.taskId,
    });
    if (result.status === 'ready') return result.solution;
    await sleep(3000);
  }
  throw new Error(`task ${created.taskId} was not ready in ${POLL_ATTEMPTS} polls`);
}

// Optional task fields are sent only when they have a value.
function withoutEmpty(fields) {
  return Object.fromEntries(
    Object.entries(fields).filter(([, value]) => value !== undefined && value !== ''),
  );
}

async function main() {
  const deviceFile = DEVICE_ID_FILE || 'device-id.txt';
  // One installation keeps one device id; reuse the id a previous run saved.
  const deviceId = fs.existsSync(deviceFile)
    ? fs.readFileSync(deviceFile, 'utf8').trim()
    : undefined;

  const solution = await solve({
    type: 'AkamaiBmpTask',
    version: BMP_VERSION,
    appPackage: APP_PACKAGE,
    appVersion: APP_VERSION,
    appVersionCode: APP_VERSION_CODE,
    serverURL: SDK_SERVER_URL,
    ...withoutEmpty({ deviceId }),
  });
  fs.writeFileSync(deviceFile, solution.deviceId);

  const headers = { 'x-acf-sensor-data': solution.header };
  // Add the headers and body the app sends with this request.
  const response = await fetch(APP_API_URL, { method: APP_API_METHOD || 'GET', headers });
  const text = await response.text();
  if (!response.ok || !text.includes(SUCCESS_TEXT)) {
    throw new Error(`The site did not accept the result (HTTP ${response.status}).`);
  }
  console.log('The site accepted the result.');
}

main().catch((error) => {
  console.error(error);
  process.exitCode = 1;
});