How to Get Access to the API
To begin, let’s explore how to access the API. Users need to log in to the developer portal using their email address. After registration, a developer receives:
- 100 test requests (one-time only).
- A secret access key for the API.
API Secret Access Key
The API secret access key is a unique identifier for the developer that must be included in the API request path for authentication. Do not share this key with anyone. If someone gains access to your key, they can use your request balance. You can find this key in your account dashboard.
For example:
//API Request URL to get all carriers
var request_url = "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/carriers";
REST API Categories
Our REST API is divided into two main categories:
Parcels
- Identify carriers based on a parcel’s tracking number.
- Track a parcel with automatic carrier detection.
- Track a parcel with a specified carrier.
Carriers
- View a complete list of supported carriers.
- Access detailed information about a specific carrier.