Documentation

API Accounts

← Back

Throughout This Page

You can jump to the specified sections by clicking on these titles.

Overview

Upon completing your registration with Shipping API services, your initial step involves establishing an API user account. The central objective of the API Accounts page is to oversee the administration, modification, and removal of API accounts, facilitating the subsequent label generation process.

This documentation will comprehensively acquaint you with all the segments and functionalities accessible on the API Accounts page. Our guide will encompass initiating a fresh API account, deactivating it if necessary, and integrating authentication details—courier credentials. Furthermore, an exploration of the Keys & Tokens, View Shipments and Actions sections will also be presented.

Accessing the API Accounts Page

Select the prominently marked "API Accounts" button in the left-hand menu.

Creating a New API Group

Employing an API Group allows you to cluster API Accounts together within the groups you establish. It proves advantageous when you aim to categorize the accounts you possess alongside the authentications you've implemented.

This procedure closely resembles the creation of API Accounts, but it's notably more streamlined.

To initiate this process, select the "Create" button in the page's upper right corner. Following this, opt for "Create API Group" from the dropdown menu that appears. A window will materialize at the centre of the screen, prompting you to assign a name to your group. Upon naming, finalize the process by clicking the "Create Group" button.

Subsequently, you gain the ability to generate fresh API Accounts within the newly formed group or transfer existing API accounts from other groups into this newly established one.

Kindly be aware that all API Accounts need to reside within an API Group. You must create one before creating an API Account.

Creating a New API Account

The "API Accounts" page comprehensively lists API accounts associated with your user profile. It's possible to have multiple API accounts linked to a single user. Depending on your usage scenario, you might only require one API account as an individual API user. However, if you function as a reseller or an agency, managing the Shipping API on behalf of different clients, the option exists to maintain multiple API user accounts.

Access the "Create" button in the upper right-hand corner to initiate creating a new API account. From the ensuing dropdown menu, select "Create API Account."

After opting for "Create New API Account," furnish a Name for the account and generate a unique key within the ensuing window. This key is exclusive to your account. While you won't need to input it directly into your requests, it's advisable to store it securely. Although infrequently required, this key becomes essential for specific applications, such as internal applications within the DC framework.

Upon completing these steps, finalize the process by selecting "Save Changes." Subsequently, your freshly generated API account will be visible on the page, ready for utilization.

Registering New Auths

Upon obtaining your API credentials for the courier service, the next step involves registering them with the Shipping API. This process ensures that your credentials are securely stored within the Shipping API system, eliminating the necessity of including them with each request. These credentials are your authentication details for the courier, and to integrate a courier into the Shipping API, you need to register a new authentication.

To begin registering a new authentication, navigate to the "API Account" page and locate the "View Registered Auths" section. Adjacent to this, you'll find a plus icon – click on it.

Triggering the plus icon initiates a dropdown menu containing courier names.

You can choose the specific courier or couriers you have in mind by inputting the corresponding courier authentications. After selecting the courier, proceed to complete the necessary fields.

Company: You can add a company name for differentiation purposes. This field is handy if you possess multiple accounts associated with the same courier; adding a company name aids in distinguishing between these accounts.
Testing Flag: Ensure that the Testing field aligns with your current mode. If you're operating in a testing environment, mark this field as "Yes"; otherwise, leave it as "No."
Credentials: Enter any courier-specific information required in these dedicated fields.

Once you've diligently filled in these details, finalize the process by clicking "Save Changes." Congratulations, you've now effectively registered a new authentication within the system.

Viewing Registered Auths

Click the "View Registered Auths" option to access your registered authentications.

Upon opening the pop-up, you can review both the "View Presets" and "Details" associated with each authentication. Should the need arise, you can also remove registered authentications by clicking on the red bin icon.

View Presets: This option lets you observe the presets configured for the courier linked to the registered authentication. Clicking on "View Presets" will seamlessly redirect you to the service directory of the chosen courier. Within this directory, you can review existing presets or establish new ones.
Details: Through the "Details" button, you can delve into the specifics of the authentication. It encompasses information such as the username and password or API keys. Moreover, you can make alterations to these details as required.
Trash Bin Icon: The trashbin icon facilitates the removal of an authentication from your API Account. This action can be performed whenever deemed necessary.

Keys & Tokens

Upon selecting this button, you'll encounter two distinct sections: the "Account Key" segment and a section dedicated to Tokens.

Account Key: As previously discussed in this document, when generating a new API account, a unique key is generated exclusively for that account. In this section, you can both "Re-Generate Key" and "Reset Key."

A word of caution: Should you choose to reset the key while it's concurrently in use by your applications, it will lead to a disruption, necessitating an update to the key with a fresh one. This action might be taken to revoke access. Nevertheless, we advise using tokens, which yield a similar outcome. Tokens offer the advantage of enabling you to create multiple instances, each serving different use cases.

Tokens: Tokens are indispensable for crafting authentication requests via the API. They serve as identifiers for requests originating from specific API users. Consequently, a token associated with the relevant API user is essential to verify a request's authenticity. Within this section, you can review previously generated tokens or generate new ones. To create a fresh token, click the "Create Token" button.

Following this, assign a name to your token and proceed by selecting "Create Token" once again.

Upon preservation, your newly minted token will become visible on the lower part of the screen. The corresponding token value can be found here. If, at any point, you desire to eliminate a particular token, you can do so by clicking on the adjacent bin icon.

View Shipments

Upon selecting the "View Shipments" button, a redirection will take place, guiding you to the Shipments page. An encompassing list of all shipment requests dispatched by the specific API account will be visible here.

For a deeper understanding of shipments and a comprehensive exploration of the Shipments page, we recommend consulting the Shipments Document.

Actions

Disable: You can deactivate one or multiple API Accounts at your discretion by selecting the "Disable" button. Deactivating an API account will restrict its access. Once deactivated, the button will transition to green and display "Enable," facilitating the reactivation process for future utilization.
Change Group: This functionality empowers you to transfer the chosen API account to a different API Group, facilitating organized management.
Delete API Account: If needed, you can erase an API Account or multiple accounts by clicking the bin icon adjacent to the "Disable" button.