Skip to main content

Digital Out Of Home

Adhese has 2 endpoints in place for DOOH integrations:

  1. Assets Download Endpoint (aka Headsup request)
    https://headsup-[customer].adhese.org/api/headsup/download-list/sl[positioncode] 

  2. Playlist Endpoint
    https://ads-[customer].adhese.com/m/stack/sl[positioncode]?max_ads=[amount]

Assets download endpoint

The headsup endpoint returns all materials for the campaigns running on the requested DOOH position. The JSON response consists of an array "media" which can be empty or filled with several "ad" objects depending on the amount of active campaigns. 

The "Use in headsup file" setting needs to be activated on format level to make sure the relevant ads are available in the response. This action can be performed in the Adhese UI by all admin users.

{
    "media": [
        {
            "ad": {
                "id": "https://pool-[account].adhese.com/pool/lib/97_3rd_1.png",
                "mime": "image/png",
                "curl": "https://pool-[account].adhese.com/pool/lib/97_3rd_1.png",
                "checksum": "9d3e92f16382e9dbd480cdc3a6b2beabcd2c11c2b1e65a65812404240ff5db"
            }
        },
        {
            "ad": {
                "id": "https://pool-[account].adhese.com/pool/lib/56_2nd_1.mp4",
                "mime": "video/mp4",
                "curl": "https://pool-[account].adhese.com/pool/lib/56_2nd_1.mp4",
                "checksum": "925b53ac94eec59a095464a937c106c22b77b95455f2ee38e5cfb374ff3065"
            }
        }
    ]
}

Playlist endpoint

The playlist endpoint returns a subset of DOOH campaigns running on the requested DOOH position. The JSON response consists of an array "ads" which can be empty or filled with several objects depending on the amount of active campaigns. The maximum amount of returned ads is determined by the required "max_ads" parameter.

The structure of the JSON object that is returned for each campaign needs to be configured by use of an advar template. An example response:

{
    "ads": [
        {
            "id": "https://pool-[account].adhese.com/pool/lib/1_2nd_2.mp4",
            "dur": 10,
            "prio": 15,
            "externalKey": "CI-X",
            "proofOfPlay": "https://ads-[account].adhese.com/track/1//sl1/tlnone/A2?1718190774050",
            "error": "https://ads-[account].adhese.com/track/1-PLAY_ERROR_[ERRORCODE]//sl1/?1718190774050"
        }
    ]
}

 

Back to top