PDF.co Web API – PDF To JSON API – PHP – Convert PDF To JSON Asynchronously

Home
/
Articles
/
PDF.co Web API – PDF To JSON API – PHP – Convert PDF To JSON Asynchronously

PDF.co Web API – PDF To JSON API – PHP – Convert PDF To JSON Asynchronously

pdf-to-json-async.php

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Cloud API asynchronous "PDF To JSON" job example (allows to avoid timeout errors).</title>
</head>
<body>
 
<?php 
 
// Cloud API asynchronous "PDF To JSON" job example.
// Allows to avoid timeout errors when processing huge or scanned PDF documents.
 
 
// The authentication key (API Key).
// Get your own by registering at https://app.pdf.co/documentation/api
$apiKey = "***********************************";
 
// Direct URL of source PDF file. Check another example if you need to upload a local file to the cloud.
$sourceFileUrl = "https://s3-us-west-2.amazonaws.com/bytescout-com/files/demo-files/cloud-api/pdf-to-text/long-processed-document.pdf";
// Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$pages = "";
// PDF document password. Leave empty for unprotected documents.
$password = "";
 
 
// Prepare URL for `PDF To JSON` API call
$url = "https://api.pdf.co/v1/pdf/convert/to/json" . 
    "?url=" . $sourceFileUrl .
    "&password=" . $password .
    "&pages=" . $pages .
    "&async=true"; // (!) Make asynchronous job
 
// Create request
$curl = curl_init();
curl_setopt($curl, CURLOPT_HTTPHEADER, array("x-api-key: " . $apiKey));
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
 
// Execute request
$result = curl_exec($curl);
 
if (curl_errno($curl) == 0)
{
    $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
     
    if ($status_code == 200)
    {
        $json = json_decode($result, true);
         
        if ($json&#91;"error"&#93; == false)
        {
            // URL of generated JSON file that will available after the job completion
            $resultFileUrl = $json&#91;"url"&#93;;
            // Asynchronous job ID
            $jobId = $json&#91;"jobId"&#93;;
             
            // Check the job status in a loop
            do
            {
                $status = CheckJobStatus($jobId); // Possible statuses: "InProgress", "Failed", "Aborted", "Finished".
                 
                // Display timestamp and status (for demo purposes)
                echo "<p>" . date(DATE_RFC2822) . ": " . $status . "</p>";
                 
                if ($status == "Finished")
                {
                    // Display link to the file with conversion results
                    echo "<div><h2>Conversion Result:</h2><a href='" . $resultFileUrl . "' target='_blank'>" . $resultFileUrl . "</a></div>";
                    break;
                }
                else if ($status == "InProgress")
                {
                    // Pause for a few seconds
                    sleep(3);
                }
                else 
                {
                    echo $status . "<br/>";
                    break;
                }
            }
            while (true);
        }
        else
        {
            // Display service reported error
            echo "<p>Error: " . $json["message"] . "</p>"; 
        }
    }
    else
    {
        // Display request error
        echo "<p>Status code: " . $status_code . "</p>"; 
        echo "<p>" . $result . "</p>"; 
    }
}
else
{
    // Display CURL error
    echo "Error: " . curl_error($curl);
}
 
// Cleanup
curl_close($curl);
 
 
function CheckJobStatus($jobId)
{
    $status = null;
     
    // Create URL
    $url = "https://api.pdf.co/v1/job/check?jobid=" . $jobId;
     
    // Create request
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $url);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
     
    // Execute request
    $result = curl_exec($curl);
     
    if (curl_errno($curl) == 0)
    {
        $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         
        if ($status_code == 200)
        {
            $json = json_decode($result, true);
         
            if ($json["error"] == false)
            {
                $status = $json["Status"];
            }
            else
            {
                // Display service reported error
                echo "<p>Error: " . $json["message"] . "</p>"; 
            }
        }
        else
        {
            // Display request error
            echo "<p>Status code: " . $status_code . "</p>"; 
            echo "<p>" . $result . "</p>"; 
        }
    }
    else
    {
        // Display CURL error
        echo "Error: " . curl_error($curl);
    }
     
    // Cleanup
    curl_close($curl);
     
    return $status;
}
 
?>
 
</body>
</html>

Click here to get your Free Trial version of the SDK

PDF.co Web API – PDF To JSON API – PHP – Convert PDF To JSON Asynchronously

PDF.co Web API – PDF To JSON API – PHP – Convert PDF To JSON Asynchronously

Tutorials: