Throughout This Page
You can jump to the specified sections by clicking on these titles.
Overview
The Playground serves as a simulation platform for label requests, aiding in understanding label creation logic and sending requests to the Courier API. It also accommodates other courier label submissions and real API credential usage (which can incur charges) while allowing label modification and validation through the API Dashboard or Shipment page.
Creating a Label
The Playground provides a platform for simulating label requests and manipulating outgoing and incoming data. It aids in comprehending the underlying logic governing label creation.
In essence, the Playground facilitates the transmission of requests from our application, aiding in the comprehension of the process involved in sending requests from your application to the Courier API.
However, the functionality of the Playground extends beyond the simulation of label requests exclusively. It's essential to note that utilizing real API credentials within the Playground will result in charges being applied to your account by the courier for request submission.
By default, the Playground features a Royal Mail endpoint. However, you can also leverage it to submit label requests to other couriers. For instance, without altering any settings, clicking "Send Request" will forward a request through our Royal Mail test account, generating a label in return.
Selecting "View Label" lets you examine the generated label, a Royal Mail label directed to our head office in Driffield.
Should you wish to modify this information to validate the functionality of your account, adjustments can be made to the "API User" and "API Token". Employing the same credentials registered on the API Accounts page and inputting them (as demonstrated in the image below), then initiating another "Send Request" action within the Playground, will generate another label.
Subsequently, visiting the Courier API Dashboard or the Shipment page will reveal the label you've successfully generated.
