Installation¶
The recommended way to install the PostNL library is through Composer. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.
This chapter assumes that you meet all the requirements as described in the Overview chapter.
Install composer with the instructions on this page: https://getcomposer.org/download/
Install through Composer¶
Install the PostNL library:
composer require firstred/postnl-api-php
You can optionally add the well-known Guzzle HTTP client as a dependency using composer:
composer require guzzlehttp/guzzle
This library will prefer the Guzzle client and automatically start using it instead of the built-in cURL-client.
Note
After installing, you need to require Composer’s autoloader somewhere in your project, which is not necessary if you are using a framework such as Laravel or Symfony, for example.
You can require the autoloader as follows (assuming the vendor/ dir is relative to your current directory):
require_once 'vendor/autoload.php';
You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at getcomposer.org.
Install the latest development build through composer¶
During your development, you can keep up with the latest changes on the master
branch by setting the version requirement for this library to dev-1.2.x.
{
"require": {
"firstred/postnl-api-php": "dev-1.2.x"
}
}
Note
You will likely have to change the min-stability setting: