This API endpoint returns all available formats and their Format ID that Promo Only offers via the POOL service. This list is used primarily for preferences to setup format filters, so that a user can block or unblock specific formats from showing up in their distribution feed.
Example JSON Output
[
{
"format": "All Promo Only Formats",
"id": 0
},
{
"format": "Alternative Video",
"id": 68
},
{
"format": "Chart Video HD Daily",
"id": 71
},
{
"format": "Club Video",
"id": 5
},
{
"format": "Country Video",
"id": 4
},
{
"format": "Dance Mix Video",
"id": 3
},
{
"format": "Express Video",
"id": 14
},
{
"format": "Hits HD",
"id": 67
}
]
PHP (using cURL):
<?php
$userid = 1;
$token = "8b26e1e4f3f5e00a888807e605565c47";
$formats_url = "https://api.promoonly.com/formats";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $formats_url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer ".base64_encode($userid.":".$token)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$formats_result = curl_exec($ch);
curl_close($ch);
$formats_obj = json_decode($formats_result);
?>
Javascript (using jQuery):
function b64EncodeUnicode(str)
{
return btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g,
function toSolidBytes(match, p1)
{
return String.fromCharCode('0x' + p1);
}));
}
var userid = 1;
var token = "8b26e1e4f3f5e00a888807e605565c47";
var auth_str = "Bearer " + b64EncodeUnicode(userid + ":" + token);
$.ajax({
type: "GET",
url: "https://api.promoonly.com/formats",
headers: { "Authorization": auth_str },
dataType: "json",
success: function (data)
{
console.log(data);
}
});
Python (using requests):
#!/usr/bin/env python
import requests
import base64
import urllib
userid = 1
token = "8b26e1e4f3f5e00a888807e605565c47"
b64_key = base64.b64encode("%s:%s" % (userid, token))
headers = {"Authorization": "Bearer %s" % b64_key}
formats_url = "https://api.promoonly.com/formats"
result_return = requests.get(formats_url, headers=headers)
print(result_return.text)