Choose between the formats “json” and “xml” to get the PDF as a Base64 string within the field “file” and the name of the data file within the field “name”. If you choose the format “pdf” you will get the pdf file.
Parameter
Labeling
Description
Values margin
Default value
id
Unique identifier for compiled and downloadable report.
(0-9)+
–
format
Defines in which format the result will be returned.
json|xml|pdf
json
Return values
Labeling
Description
name
Contains a unique designator for an already created and thus downloadable report.
file
Contains a PDF file.
Messages
Message
Description
no permission
The key has no access to this function.
internal error
An internal error occured.
param missing
A required parameter is missing.
param invalid
The value of a parameter is not valid.
result empty
The request was successful, but the result itself is empty.
cost error
The current credit amount is not sufficient to handle the request.
0k.
The processing was successful.
Exemplary code
$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' =>'report',
'method' =>'getPdf',
'key' =>'myPersonalKey',
'id' =>'getDownloads-Id',
'format' =>'pdf',
);
$GETparams = implode('/', $arrayParams);
$requestURL = $root.$GETparams;
if (!function_exists('curl_init')) die('cURL not available');
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
// Download the given URL, and return output
$output = curl_exec($ch);
// Close the cURL resource, and free system resources
curl_close($ch);
echo $output;
?>
