Download the PHP package thirtybees/postnl-api-php without Composer
On this page you can find all versions of the php package thirtybees/postnl-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download thirtybees/postnl-api-php
More information about thirtybees/postnl-api-php
Files in thirtybees/postnl-api-php
Informations about the package postnl-api-php
Unofficial PostNL REST API PHP Bindings
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
Service | Status | Version |
---|---|---|
Addresses | ||
Adrescheck Nationaal | N/A | N/A |
Adrescheck Basis Nationaal | N/A | N/A |
Adrescheck Internationaal | N/A | N/A |
Geo Adrescheck Nationaal | N/A | N/A |
Creditworthiness & Business information | ||
Bedrijfscheck Nationaal | N/A | N/A |
Kredietcheck Zakelijk | N/A | N/A |
Send & Track | ||
Barcode webservice | ✓ | 1.1 |
Labelling webservice | ✓ | 2.2 |
Confirming webservice | ✓ | 2.0 |
Shippingstatus webservice | ✓ | 2.0 |
Shipping webservice | ✓ | 2.0 |
Delivery Options | ||
Deliverydate webservice | ✓ | 2.2 |
Location webservice | ✓ | 2.1 |
Timeframe webservice | ✓ | 2.1 |
Checkout webservice | N/A * | 1.0 |
Bulkmail webservice | N/A | N/A |
* 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
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
.
Then install the PHPdoc to RST tool.
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):
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
to install the requirements, followed by
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.All versions of postnl-api-php with dependencies
ext-json Version *
composer/ca-bundle Version ^1.2
guzzlehttp/psr7 Version ^1.7 || ^2.0
php-http/promise Version ^1.0
psr/cache Version ^1.0 || ^2.0 || ^3.0
psr/http-message Version ^1.0
psr/log Version ^1.0 || ^2.0 || ^3.0
setasign/fpdf Version ^1.8
setasign/fpdi Version ^2.0