Error handling

iLovePDF allows users to catch errors from all API requests. These errors can be from the Start request, Authentication, Upload files, Process task and Download. The following example shows how to catch all of these errors in a single task:

Examples using a library

try {
    // start the class manager
    $ilovepdf = new Ilovepdf("PUBLIC_KEY", "SECRET_KEY");
    // and get the task tool
    $myTask = $ilovepdf->newTask('split');
    // file var keeps info about server file id, name...
    // it can be used latter to cancel file
    $file = $myTask->addFile('/path/to/file/document.pdf');
    // set ranges to split the document
    $myTask->setRanges("2-4,6-8");
    // and set name for output file.
    // in this case it will output a zip file, so we set the package name.
    $myTask->setPackagedFilename('split_documents');
    // and name for split document (inside the zip file)
    $myTask->setOutputFilename('split');
    // process files
    // time var will have info about time spent in process
    $time = $myTask->execute();
    // and finally download file. If no path is set, it will be downloaded on current folder
    $myTask->download('path/to/download');
    // catch possible errors
    // Start task errors
} catch (\Ilovepdf\Exceptions\StartException $e) {
    echo "An error occured on start: " . $e->getMessage() . " ";
    // Authentication errors
} catch (\Ilovepdf\Exceptions\AuthException $e) {
    echo "An error occured on auth: " . $e->getMessage() . " ";
    echo implode(', ', $e->getErrors());
    // Uploading files errors
} catch (\Ilovepdf\Exceptions\UploadException $e) {
    echo "An error occured on upload: " . $e->getMessage() . " ";
    echo implode(', ', $e->getErrors());
    // Processing files errors
} catch (\Ilovepdf\Exceptions\ProcessException $e) {
    echo "An error occured on process: " . $e->getMessage() . " ";
    echo implode(', ', $e->getErrors());
    // Downloading files errors
} catch (\Ilovepdf\Exceptions\DownloadException $e) {
    echo "An error occured on process: " . $e->getMessage() . " ";
    echo implode(', ', $e->getErrors());
    // Other errors (as connexion errors and other)
} catch (\Exception $e) {
    echo "An error occurred: " . $e->getMessage();
}

// Under construction

# Under construction

try {
    // Start an API instance.
    ilovepdf = new Ilovepdf("PUBLIC_KEY", "SECRET_KEY");
    // Get tool.
    myTask = ilovepdf.newTask('split');
    // Add file from URL.
    myTask.addFile('/path/to/file/document.pdf');
    // Process files.
    myTask.process({
        ranges: '2-4,6-8',
    });
    // Download data in a local file.
    const data = await myTask.download('path/to/download');
    fs.writeFileSync('foldername/folder1/', data);
} catch (Error err) {
    if (err instanceof AuthError) {
        console.log('Error on auth!');
    }
}