Convert API PHP Client
The ConvertAPI helps converting various file formats. Creating PDF and Images from various sources like Word, Excel, Powerpoint, images, web pages or raw HTML codes. Merge, Encrypt, Split, Repair and Decrypt PDF files. And many others files manipulations. In just few minutes you can integrate it into your application and use it easily.
PHP 5.4.0 and later.
Once composer is installed, execute the following command in your project root to install this library:
composer require convertapi/convertapi-php
If you do not wish to use Composer, you must require ConvertApi autoloader:
Library requires the following extensions in order to work properly:
If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.
You can get your secret at https://www.convertapi.com/a
use \ConvertApi\ConvertApi; ConvertApi::setApiSecret('your-api-secret');
Example to convert file to PDF. All supported formats and options can be found here.
$result = ConvertApi::convert('pdf', ['File' => '/path/to/my_file.docx']); # save to file $result->getFile()->save('/path/to/save/file.pdf');
Other result operations:
# save all result files to folder $result->saveFiles('/path/to/save/files'); # get conversion cost $cost = $result->getConversionCost();
$result = ConvertApi::convert('pdf', ['File' => 'https://website/my_file.docx']);
$result = ConvertApi::convert( 'pdf', ['File' => '/path/to/my_file'], 'docx' );
ConvertAPI accepts extra conversion parameters depending on converted formats. All conversion parameters and explanations can be found here.
$result = ConvertApi::convert( 'pdf', [ 'File' => '/path/to/my_file.docx', 'PageRange' => '1-10', 'PdfResolution' => '150', ] );
You can always check remaining seconds amount by fetching user information.
$info = ConvertApi::getUser(); echo $info['SecondsLeft'];
You can find more advanced examples in the examples/ folder.
Testing is done with PHPUnit:
Bug reports and pull requests are welcome on GitHub at https://github.com/ConvertAPI/convertapi-php. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
ConvertAPI PHP Client is available as open source under the terms of the MIT License.