README

Convert your files with our online file conversion API

ConvertAPI helps in 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 other file manipulations. You can integrate it into your application in just a few minutes and use it easily.

Requirements

PHP 8.1.0 and later.

Installation

The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.

Once composer is installed, execute the following command in your project root to install this library:

composer require convertapi/convertapi-php

Manual Installation

If you do not wish to use the Composer, you must require ConvertApi autoloader:

require_once('/path/to/convertapi-php/lib/ConvertApi/autoload.php');

Dependencies

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.

Usage

Configuration

You can get your API credentials at https://www.convertapi.com/a

use \ConvertApi\ConvertApi;

ConvertApi::setApiCredentials('your-api-secret-or-token');

File conversion

Convert file to PDF example. 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');

# get file contents (without saving the file locally)
$contents = $result->getFile()->getContents();

Other result operations:

# save all result files to folder
$result->saveFiles('/path/to/save/files');

# get conversion cost
$cost = $result->getConversionCost();

Convert file url

$result = ConvertApi::convert('pdf', ['File' => 'https://website/my_file.docx']);

Specifying from format

$result = ConvertApi::convert(
    'pdf',
    ['File' => '/path/to/my_file'],
    'docx'
);

Additional conversion parameters

ConvertAPI accepts additional conversion parameters depending on selected 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',
    ]
);

User information

You can always check your usage by fetching user information.

$info = ConvertApi::getUser();

echo $info['ConversionsConsumed'];

Alternative domain

Use setApiBase method to set alternative service domain. Dedicated to the region domain list.

ConvertApi::setApiBase('https://eu-v2.convertapi.com/');

More examples

Find more advanced examples in the examples/ folder.

Development

Testing is done with PHPUnit:

CONVERT_API_SECRET=your-api-secret ./bin/phpunit

Contributing

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.

License

ConvertAPI PHP Client is available as open source under the terms of the MIT License.

convertapi / convertapi-php

Maintainers

Details