Beacon integration

This section describes the Encoder to Akamai integration of beacons.

Encoders must send beacons to Akamai that:

  • Use HTTPS::POST methods.
  • Include the beacon contents in the POST request body.
  • Where possible, bundle multiple beacons of a given kind together in the same POST request.

    For example,

    • Multiple heartbeat beacons can be bundled in one POST request with beacons separated by new line.
    • Multiple alert beacons can be bundled in one POST request with beacons separated by new line.
  • Beacons of different types cannot be merged in a single POST request. Arbitrary combinations of heartbeats/config beacons/alert beacons are not allowed.
  • The target path for the POST requests differs based on the beacon type.

    For Configuration beacons, use: http://{hostname.domain}/encoder/{encoderid}/config

    For System heartbeat beacon, use: http://{hostname.domain}/encoder/{encoderid}/heartbeat/system

    For Stream heartbeat beacons, use http://{hostname.domain}/encoder/{encoderid}/heartbeat/stream

    For Alert beacons, use http://{hostname.domain}/encoder/{encoderid}/alert

    Note: Obtain the {hostname.domain} and {encoderid} from Akamai as part of the provisioning flow for encoder integration.