budgetlens/postl-rest-api-client

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP Client for PostNL Rest API

0.1.0 2020-09-02 14:44 UTC

This package is auto-updated.

Last update: 2021-09-10 15:00:14 UTC


README

Client for the PostNL Rest API

Attention!

Currently this project is stalled as no access to the PostNL is currently available to us.
Sorry for the inconvenience

Installation

composer require 123lens/postnl-rest-api-client

Client initialization:

use Budgetlens\PostNLApi\RestApiClient;
$client = new RestApiClient('---  YOUR APIKEY ---');

Testing

./vendor/bin/phpunit 

Examples

See tests folder

Implementation Status

This library is still in development. After an endpoint implementation is finished a new (sub)version will be released.
Meaning of Is finished::

  • All available services for endpoint are completed
  • unit tests are available

Current Development State

Service Version Implemented
Addresses More info
Adrescheck Nationaal v1
Adrescheck Internationaal v1
Geo Adrescheck Nationaal v1
Adrescheck Basis Nationaal v1
Send and Track More info
Shipping webservice v1
Barcode webservice v1
Labelling webservice v1
Confirming webservice v1
Shippingstatus webservice v1
Delivery Options More info
Deliverydate webservice v1
Location webservice v1
Timeframe webservice v1
Checkout More info
Checkout Postalcode Check v1
Checkout API v1
Customer Overview More info
Bedrijfscheck Nationaal v1

Endpoint/Service specific

Adrescheck Nationaal

No contract for this service, tests not 100%!

Base endpoint: /address/national

Endpoint Version Implemented Tested
/v1/validate/ v1

Adrescheck Internationaal

No contract for this service, tests not 100%!

Base endpoint: /address/international

Endpoint Version Implemented Tested
/v1/labelformat v1
/v1/validate v1

Geo Adrescheck Nationaal

No contract for this service, tests not 100%!

Base endoint: /address/national

Endpoint Version Implemented Tested
/v1/geocode v1

Adrescheck Basis Nationaal

No contract for this service, tests not 100%!

Base endoint: /address/sequence

Endpoint Version Implemented Tested
/v1/postalcode v1

Shipping webservice

Base endoint: /

Endpoint Version Implemented Tested
/v1/shipment v1

Barcode webservice

Base endoint: /shipment/v1_1

Endpoint Version Implemented Tested
/barcode v1_1

Labelling webservice

Base endoint: /shipment/v2_2

Endpoint Version Implemented Tested
/label v2_2

Confirming webservice

Base endoint: /shipment/v2

Endpoint Version Implemented Tested
/confirm v2

Shippingstatus webservice

Base endoint: /shipment

Endpoint Version Implemented Tested
/v2/status/barcode v2
/v2/status/reference v2
/v2/status/lookup v2
/v2/status/signature v2
/v2/status/{customerNumber}/updatedshipments v2

Deliverydate webservice

Base endoint: /shipment

Endpoint Version Implemented Tested
/v2_2/calculate/date/delivery v2_2
/v2_2/calculate/date/shipping v2_2

Location webservice

Base endoint: /shipment

Endpoint Version Implemented Tested
/v2_1/locations/nearest v2_1
/v2_1/locations/nearest/geocode v2_1
/v2_1/locations/area v2_1
/v2_1/locations/lookup v2_1

Timeframe webservice

Base endoint: /shipment/v2_1

Endpoint Version Implemented Tested
/calculate/timeframes v2_1

Checkout Postalcode Check

Base endoint: /shipment/checkout

Endpoint Version Implemented Tested
/v1/postalcodecheck/ v1

Checkout API

Base endoint: /shipment/v1

Endpoint Version Implemented Tested
/checkout v1

Bedrijfscheck Nationaal

No contract for this service, tests not 100%!

Base endoint: /company/search

Endpoint Version Implemented Tested
/v3/phonenumber/ v3