Request API: Headsup endpoint
The headsup endpoint returns all the materials for the campaigns running on the requested DOOH position.
It can be used by the DOOH screens to retrieve and cache all materials at the beginning of the day to avoid delays by having to download materials during the day.
To ensure that the assets are included in the response, the Use in heads-up file setting must be enabled at format level. This action can be performed by all admin users in the Adhese UI.
https://headsup-[customer].adhese.org/api/headsup/download-list/sl[positioncode]| Parameters | Value | Required |
| customer | The name of your Adhese account | Yes |
| position code | The code of the position you wish to request: [location code][optional position code]-[format code]. This value is always prefixed by 'sl'. | Yes |
Response
The JSON response consists of a "media" array that may be empty or populated with multiple ad objects, depending on the number of active campaigns. The structure of an ad object is fixed and can not be customized.
The ID and URL from which to download the file is identical and is also available in the stack endpoint that will be used to download DOOH playlists during the day.
Example
{
"media":[
{
"ad":{
"id":"https://pool-demo.adhese.com/pool/lib/562_2nd_1.mp4",
"mime":"video/mp4",
"curl":"https://pool-demo.adhese.com/pool/lib/562_2nd_1.mp4",
"filesize": 15470592,
"checksum":"071f717962db99cc137d138696d33209f2e4818d42a54f70dfa6606eeb1b640b"
}
},
{
"ad":{
"id":"https://pool-demo.adhese.com/pool/lib/560_2nd_1.mp4",
"mime":"video/mp4",
"curl":"https://pool-demo.adhese.com/pool/lib/560_2nd_1.mp4",
"filesize": 15470592,
"checksum":"4e78745a33518ff22c1c9f39852a49c1c0fadd0adf722e3394ad1215d5e5ff5b"
}
},
{
"ad":{
"id":"https://pool-demo.adhese.com/pool/lib/561_2nd_1.mp4",
"mime":"video/mp4",
"curl":"https://pool-demo.adhese.com/pool/lib/561_2nd_1.mp4",
"filesize": 6582272,
"checksum":"64d2eab6d51b208c0cec3fc4d64c53381e5d41ae2a1d4c5b7704b1818bdb6158"
}
}
]
}