firstred / postnl-api-php
PostNL REST API PHP Bindings
Installs: 411 967
Dependents: 1
Suggesters: 0
Security: 0
Stars: 26
Watchers: 8
Forks: 37
Open Issues: 4
Requires
- php: ^8.1
- composer/ca-bundle: ^1.0
- guzzlehttp/promises: ^1.0 || ^2.0
- guzzlehttp/psr7: ^1.7 || ^2.0
- paragonie/hidden-string: ^2.0
- php-http/discovery: ^1.9.1
- psr/cache: ^1.0 || ^2.0 || ^3.0
- psr/clock: ^1.0
- psr/http-factory: ^1.0
- psr/http-factory-implementation: *
- psr/http-message: ^1.0
- psr/http-message-implementation: *
- psr/log: ^1.0.2 || ^2.0 || ^3.0
- setasign/fpdf: ^1.8
- setasign/fpdi: ^2.3
- symfony/deprecation-contracts: ^2.1 || ^3.0
Requires (Dev)
- cache/void-adapter: ^1.2
- friendsofphp/php-cs-fixer: ^3.16
- guzzlehttp/guzzle: ^7.2
- monolog/monolog: ^3.0
- php-http/mock-client: ^1.3
- phpunit/phpunit: ^10.0
- symfony/clock: ^6.0
- symfony/dotenv: ^6.0
Suggests
- abbadon1334/phpdoc-to-rst: Build the documentation
- giggsey/libphonenumber-for-php: To automatically format and check phone numbers -- supports ^8.12
- guzzlehttp/guzzle: One of the most popular HTTP clients available -- supports ^7.0
- guzzlehttp/psr7: One of the most popular HTTP clients available -- supports ^7.0
- php-http/httplug: Required if you want to use an alternative PSR-18, async or HTTPlug Client
- php-http/message-factory: Required if you want to use an alternative PSR-18, async or HTTPlug Client
- psr/http-factory: Required if you want to use an alternative PSR-18, async or HTTPlug Client
- symfony/http-client: Another popular HTTP client you can use natively -- supports ^5.4
- v2.0.x-dev
- v2.0.11
- v2.0.10
- v2.0.9
- v2.0.8
- v2.0.7
- v2.0.6
- v2.0.5
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v2.0.0-beta.6
- v2.0.0-beta.5
- v2.0.0-beta.4
- v2.0.0-beta.3
- v2.0.0-beta.2
- v2.0.0-beta.1
- v1.4.x-dev
- v1.4.6
- v1.4.5
- v1.4.4
- v1.4.3
- v1.4.2
- v1.4.1
- v1.4.0
- v1.3.x-dev
- v1.3.19
- v1.3.18
- v1.3.17
- v1.3.16
- v1.3.15
- v1.3.14
- v1.3.13
- v1.3.12
- v1.3.11
- v1.3.10
- v1.3.9
- v1.3.8
- v1.3.7
- v1.3.6
- v1.3.5
- v1.3.4
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.x-dev
- v1.2.4
- v1.2.3
- v1.2.2
- v1.2.1
- v1.2.0
- v1.2.0-beta.8
- v1.2.0-beta.7
- v1.2.0-beta.6
- v1.2.0-beta.5
- v1.2.0-beta.4
- v1.2.0-beta.3
- v1.2.0-beta.2
- v1.2.0-beta.1
- v1.2.0-alpha.4
- v1.2.0-alpha.3
- v1.2.0-alpha.2
- v1.2.0-alpha.1
- v1.2.0-alpha.0
- v1.1.x-dev
- v1.1.0
- v1.0.0
- 1.0.0-beta.1
- dev-null-logger
- dev-abandoned-v2.0.x-attempt
This package is auto-updated.
Last update: 2024-10-18 11:09:29 UTC
README
About
This unofficial PHP library for the PostNL REST API aims to provide a simple way to connect your
application with PostNL. By abstracting away needless complexity when processing shipment
information and increased fault-tolerance, you can get up and running with PostNL in minutes.
At the lower level this library uses asynchronous communication and payload splitting for
improved performance.
Status
* PostNL::getTimeframesAndNearestLocations
can be used as an alternative with more functionality: https://postnl-php.readthedocs.io/en/v1.4.x/quickstart.html#requesting-timeframes-location-and-delivery-date-at-once
Instructions
- Clone this repo
- Run
composer install
(Don't have composer? Visit https://getcomposer.org/) - Optionally run
composer require guzzlehttp/guzzle
to use Guzzle instead of cURL directly - You're good to go! A small example can be found in this README. Check out the full documentation for a quick start guide.
Documentation
Example
Allow a user to download a label using the default REST API
<?php use Firstred\PostNL\PostNL; use Firstred\PostNL\Entity\Customer; use Firstred\PostNL\Entity\Address; use Firstred\PostNL\Entity\Shipment; use Firstred\PostNL\Entity\Dimension; require_once __DIR__.'/vendor/autoload.php'; $customer = Customer::create([ 'CollectionLocation' => '123456', 'CustomerCode' => 'DEVC', 'CustomerNumber' => '11223344', 'ContactPerson' => 'Peter', 'Address' => Address::create([ 'AddressType' => '02', 'City' => 'Hoofddorp', 'CompanyName' => 'PostNL', 'Countrycode' => 'NL', 'HouseNr' => '42', 'Street' => 'Siriusdreef', 'Zipcode' => '2132WT', ]), 'Email' => 'info@voorbeeld.nl', 'Name' => 'Michael', ]); $apikey = 'YOUR_API_KEY_HERE'; $sandbox = false; $postnl = new PostNL($customer, $apikey, $sandbox); $barcode = $postnl->generateBarcodeByCountryCode('NL'); $shipment = Shipment::create([ 'Addresses' => [ Address::create([ 'AddressType' => '01', 'City' => 'Utrecht', 'Countrycode' => 'NL', 'FirstName' => 'Peter', 'HouseNr' => '9', 'HouseNrExt' => 'a bis', 'Name' => 'de Ruijter', 'Street' => 'Bilderdijkstraat', 'Zipcode' => '3521VA', ]), ], 'Barcode' => $barcode, 'Dimension' => new Dimension(/* weight */ '2000'), 'ProductCodeDelivery' => '3085', ]); header('Content-Type: application/pdf'); header('Content-Disposition: attachment; filename="label.pdf"'); echo base64_decode($postnl->generateLabel( /* The actual shipment */ $shipment, /* The output format */ 'GraphicFile|PDF', /* Immediately confirm the shipment */ true ) ->getResponseShipments()[0] ->getLabels()[0] ->getContent() ); exit;
Full documentation
The full documentation can be found on this page: https://postnl-php.readthedocs.io/
Building the documentation
Generating the documentation consists of two steps:
- Generating the reference RST files of all PHP classes available in this library.
- Generating the HTML output which can be viewed with a browser.
Generating the PHP classes reference
Generating the references depends on a pretty old library. Removing other dependencies first from require-dev
may be the best workaround to install abbadon1334/phpdoc-to-rst
.
"require-dev": {
},
Then install the PHPdoc to RST tool.
composer require abbadon1334/phpdoc-to-rst -W
This repository includes a simple PHP file which utilizes the above-mentioned tool to generate the reference RST files programmatically. It also moves around a few files to integrate the reference with the rest of the documentation.
Simply run (tested w/ PHP 8.2):
php ./build-docs-reference.php
Generating the final HTML output
The documentation is automatically built and hosted on readthedocs.io. You can build a local HTML copy by installing Sphinx and running
pip install -r docs/requirements.txt
to install the requirements, followed by
sphinx-build -b html docs builddir
to build the HTML output in the directory builddir
.
License
This library has been licensed with the MIT license.
Full license text
The MIT License (MIT). Copyright (c) 2017-2023 Michael Dekker (https://github.com/firstred)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.