Quickstart - VeilRoute

1. Get a key

Request access from the dashboard. Accounts are reviewed by hand; once approved you receive an API key for the product you need — Akamai Web or Akamai BMP. Keys are per product.

2. Set your key

Keep the key server-side. Never ship it in a browser bundle or mobile app.

export VEILROUTE_KEY="your-api-key"

3. Request a sensor

Akamai Web
Akamai BMP

curl -X POST https://web.veilroute.dev/api/v1/sensor \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: $VEILROUTE_KEY" \
  -d '{"cookies":"_abck=...; bm_sz=..."}'

import os, requests

r = requests.post(
    "https://web.veilroute.dev/api/v1/sensor",
    headers={"X-Api-Key": os.environ["VEILROUTE_KEY"]},
    json={"cookies": "_abck=...; bm_sz=..."},
    timeout=30,
)
sensor = r.json()["sensor_data"]

const res = await fetch("https://web.veilroute.dev/api/v1/sensor", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": process.env.VEILROUTE_KEY,
  },
  body: JSON.stringify({ cookies: "_abck=...; bm_sz=..." }),
});
const { sensor_data } = await res.json();

curl -X POST https://bmp.veilroute.dev/api/v1/sensor \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: $VEILROUTE_KEY" \
  -d '{"app":"com.example.app"}'

import os, requests

r = requests.post(
    "https://bmp.veilroute.dev/api/v1/sensor",
    headers={"X-Api-Key": os.environ["VEILROUTE_KEY"]},
    json={"app": "com.example.app"},
    timeout=30,
)
sensor = r.json()["sensor"]

const res = await fetch("https://bmp.veilroute.dev/api/v1/sensor", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": process.env.VEILROUTE_KEY,
  },
  body: JSON.stringify({ app: "com.example.app" }),
});
const { sensor } = await res.json();

4. Send your own request

Attach the returned sensor to the real request you make, from your own proxy and egress:

Web — post sensor_data to the site’s Akamai endpoint and carry the returned cookies forward on the same session.
BMP — send sensor as the x-acf-sensor-data header on your mobile API request, paired with an OkHttp-style TLS client.

You are only charged for a sensor that returns 200.