The API section in the SAPIENT GUI is dedicated to the tools, resources, and functionalities for developers to integrate and interact with the shipping system programmatically.
This section allows external applications to communicate with the shipping software, providing access to the features like webhooks, centralised repository of countries, currencies and time zones, and detailed API documentation. It is a crucial component for businesses looking to automate their shipping processes and enhance interoperability with other systems.
In this section, you can find information on the following components:
Credentials: this section outlines the authentication details required to create and access the shipping API, such as API keys, tokens, or OAuth credentials. This ensures that only authorized users or applications can make requests to the API.
Documentation: this section provides detailed reference materials on how to use the shipping API, including endpoints, request/response formats, error handling, and example use cases.
Reference Data: this section includes the standardised read-only reference data for various attributes relevant to shipping, such as lists of countries, supported currencies, and time zone information. This data is essential for ensuring correct address formatting, currency conversions, and scheduling.
💡
Tip
To access the reference data, in the left navigation panel, select API > Reference Data. In the dropdown menu that opens, choose any of the following options whose data that you need to view:
Countries
Currencies
Time Zones
Accessing reference data
Webhooks: this section allows users to set up tracking webhook, tracking accounts, and manifest webhook. Webhooks enable asynchronous communication between SAPIENT and external applications.
