The TOP Rest Api is an APi for the automated registration of shipments in TOP via a REST web service. With the use of the TOP Rest API you can create new Shipments and retrieve the barcode labels. Updating and|or deleting shipments, and dangerous goods information are not supported for now and should be handled in the TOP website itself.
Below you will find all the details for registering shipments in TOP.
The Top Rest service is accessible through Basic Http authentication. Contact PostNL IT Service at IT.Turnhout@postnl.be for a username and password.
Rest: A service is called by sending a REST message to a service endpoint. The Rest message contains a Rest header with security information (username / password) and a JSON body which contains the service method and related parameters.
Each message that is received by the API is authenticated and authorized. The authorization mechanism determines if the user has access to the requested service. The access is aligned with the services that have been agreed between PostNL and the customer. After processing the request, the service will return a REST message with a response. The REST message contains a JSON body with information.
You can access the PostNL TOP API without writing any code. With the API key and the documentation on this website you can run sample requests, use the simulators and/ or start developing your connection(s) to the PostNL API. The easiest way to test connectivity and experience the input and output responses from our API’s is to use an API testing tool like POSTMAN.
The base endpoint of PostNl API is a publicly accessible internet address (Uri). The communication with the endpoint is secured and will be handled via HTTPS. The Uri also contains the requested functionality and version of the service.
Each service has an own version and is part of the endpoint Uri. This means that a set of used services contains different versions. A version changes when the interface specification changes. When introducing a new version, the old version will be maintained for a certain period. Sometimes an upgrade of a certain webservice is required. PostNL will give you a reasonable period of time to update
Example endpoint with version: https://api-test.tofbe.eu/v1/shipment