README

Introduction

PostNL Ecommerce APIs

Explore our technical documentation, test your integration and go live with PostNL service.

Start using PostNL APIs for e-commerce processes

To get to know the PostNL APIs better, read all about it in our API overview. Learn everything you need to about our API's before embarking on integration with PostNL.

To connect to PostNL, you can request an API key via Mijn PostNL portal. Choose your APIs and build your integration. Explore our guides, examples, and resources to guide you through each phase of integration and start testing. Ensure that you can make successful test calls towards all endpoints used in the solution.

Contact our integrations team to have your test calls reviewed and gain access to our API production environment. Once everything is configured and validated, you'll be ready to go live and start using the PostNL service.

For help contact us via our support form: Need help? Submit a case | PostNL.

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "postnl/postnl-ecommerce-sdk:1.0.5"

Or add it to the composer.json file manually as given below:

"require": {
    "postnl/postnl-ecommerce-sdk": "1.0.5"
}

You can also view the package at: https://packagist.org/packages/postnl/postnl-ecommerce-sdk#1.0.5

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
`environment`	`Environment`	The API environment. Default: `Environment.PRODUCTION_SERVER`
`timeout`	`int`	Timeout for API calls in seconds. Default: `0`
`enableRetries`	`bool`	Whether to enable retries and backoff feature. Default: `false`
`numberOfRetries`	`int`	The number of retries to make. Default: `3`
`retryInterval`	`float`	The retry time interval between the endpoint calls. Default: `1`
`backOffFactor`	`float`	Exponential backoff factor to increase interval between retries. Default: `2`
`maximumRetryWaitTime`	`int`	The maximum wait time in seconds for overall retrying requests. Default: `0`
`retryOnTimeout`	`bool`	Whether to retry on request timeout. Default: `true`
`httpStatusCodesToRetry`	`array`	Http status codes to retry against. Default: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524`
`httpMethodsToRetry`	`array`	Http methods to retry against. Default: `'GET', 'PUT'`
`customHeaderAuthenticationCredentials`	`CustomHeaderAuthenticationCredentials`	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

$client = PostnlEcommerceClientBuilder::init()
    ->customHeaderAuthenticationCredentials(
        CustomHeaderAuthenticationCredentialsBuilder::init(
            'apikey'
        )
    )
    ->environment(Environment::PRODUCTION_SERVER)
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
Production server	Default Production server
Non-Production server	Sandbox environment for testing

postnl / postnl-ecommerce-sdk

Maintainers

Details