The Zamzar PHP library provides convenient access to the Zamzar API from applications written in the PHP language. It includes a pre-defined set of classes which make it easy to submit files for conversion, retrieve converted files and utilise all of the features that the API offers.
Jump to:
- Requirements
- Installation
- Dependencies
- Documentation
- Initialise the Zamzar Client
- Test the Connection
- Typical Usage
- Configure a Logger
- Contributing
- Resources
- SDK Sampler
- Before you begin, signup for a Zamzar API Account or retrieve your existing API Key from the Zamzar Developers Homepage
- PHP 7.2.5 and later.
You can install the bindings via Composer. Run the following command:
composer require zamzar/zamzar-php
To use the bindings, use Composer's autoload:
require_once('vendor/autoload.php');
If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php
file.
require_once('/path/to/zamzar-php/init.php');
The bindings require 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.
See the SDK Guide for all of the features offered by the PHP SDK. The basics are covered below.
To initialise the client, declare a new ZamzarClient which accepts a string or config array:
// Connect to the Production API using an API Key
$zamzar = new \Zamzar\ZamzarClient('apikey');
To specify whether the client using the Production or Test API, use a Config array:
// Use the Production API
$zamzar = new \Zamzar\ZamzarClient([
'apikey' => 'apiKey',
'environment' => 'production'
]);
// Use the Sandbox API
$zamzar = new \Zamzar\ZamzarClient([
'apikey' => 'apiKey',
'environment' => 'sandbox'
]);
To confirm your credentials are correct, test the connection to the API which will return a welcome message and confirm which API you are using (Production or Test).
echo $zamzar->testConnection();
The most common requirement is to submit a job to convert a file, wait for the job to complete, download the converted files and delete the files on Zamzar servers.
// Submit the file
$job = $zamzar->jobs->submit([
'source_file' => 'path/to/local/file',
'target_format' => 'xxx'
]);
// Wait for the job to complete (the default timeout is 60 seconds)
$job->waitForCompletion([
'timeout' => 60
]);
// Download the converted files
$job->downloadTargetFiles([
'download_path' => 'path/to/folder/'
]);
// Delete the source and target files on Zamzar's servers
$job->deleteAllFiles();
The above use case might be applied when other things are happening in between each step, but if not, and you want to chain the whole thing together:
// Do the whole thing together
$job = $zamzar
->jobs
->submit([
'source_file' => 'path/to/localfile',
'target_format' => 'pdf'
])
->waitForCompletion([
'timeout' => 120
])
->downloadTargetFiles([
'download_path' => 'path/to/folder'
])
->deleteAllFiles();
The library does minimal logging of errors and information. Use either the supplied default logger or a psr-3 compatible logger.
// Default Zamzar Logger (output to the PHP error log)
$logger = new \Zamzar\Util\DefaultLogger;
$zamzar->setLogger($logger);
// PSR-3 Compatible Logger
$zamzar->setLogger($psr3logger);
// Using Monolog
$logger = new Logger('Zamzar');
$logger->pushHandler(new StreamHandler(__DIR__.'/app.log', Logger::DEBUG));
$zamzar->setLogger($logger);
We would greatly value feedback and contributions from our community.
To run tests:
-
Ensure dependencies are installed using
composer install
-
Rename the
testconfigtemplate.php
file in thetests
folder totestconfig.php
-
Specify your API Key within the
testconfig.php
file -
Run
./vendor/bin/phpunit tests
Code Samples - Copy/Paste from examples which demonstrate all key areas of functionality.
Exceptions Handling - Learn more about API Error Codes.
Developer Docs - For more information about API operations, parameters, and responses. Use this if you need additional context on all areas of functionality.
We've provided a simple app which demonstrates all features of the SDK, including code snippets to help you get started. View the SDK Sampler.