Authentication

Authentication is required when you interact with the parcelLab API to send tracking information or status updates.

Overview

You can send information to parcelLab to create trackings and status updates in our system via API. The parcelLab API uses your API token to securely authenticate requests. This means that to perform an action on the parcelLab API, you need to provide a valid API token in the Authorization header of the request.

Authentication Process

API requests are authenticated using an API token with the required scope. The API token needs to be base64 encoded with your parcelLab account ID, which is the format provided when generating an API token in the parcelLab App. To authenticate a request, provide the API token in the Authorization header of the request.

Authorization: Parcellab-API-Token <your-base64-encoded-api-key>

Public and Private Endpoints

Most endpoints in the parcelLab API require authentication. However, some endpoints are publicly available (that is: do not require authentication). These can be accessed by entering the relevant parameters in the query URL (for example: linking to the Order Status page).

Token Generation

The API token is generated in your account settings in the parcelLab App or by our Support team.

For API tokens generated in the parcelLab App, these requests authenticate with API token via Bearer Auth rather than account ID and API token.

The API token generated is base64 encoded together with your parcelLab account ID. These API tokens do not require an additional account ID as they are already account specific (that is: the parcelLab account ID is contained in the API token).

API Credentials

When you onboard with parcelLab, you will receive the necessary API credentials. The API token is user-specific and will be valid to send requests to the parcelLab API unless it is revoked. You should never share or use the API token outside of your account to ensure the security and integrity of your data. When interacting with the parcelLab API, ensure that your API token is used properly and securely in the Authorization header.

When you are up and running with the parcelLab API, you can also use our designated endpoint to create, retrieve, and revoke API tokens for users in your organization.