**Click to Play or Pause the Video**
#### **🔑 Creating an API Account (GUI Method)** Setting up an API account in **Voila** is the key to managing shipments efficiently, it enables access to shipping tools like label creation and tracking. Everything starts here, streamlining your logistics from the get-go. 1. **Navigate to API Accounts** in **Voila**. 2. **Create Groups (Optional)** for managing multiple locations. 3. **Install Couriers Per Account** to keep settings unique. ##### **🗂 API Accounts Overview:** - **API Account**: Displays account names. - **Keys & Tokens**: View/regenerate API credentials. - **Shipments**: Track all shipments sent via this account. - **Registered Auths**: Manage courier integrations. - **Status**: Activate/deactivate API accounts. - **Actions**: Move accounts between groups or delete them. 📌 **For detailed setup, check the** [**API Accounts Documentation**](https://shipping-documentation.despatchcloud.app/books/api-accounts/page/api-accounts "API Accounts Voila")**.**Before configuring your collection variables in Postman, you must refer to the [API Accounts documentation page](https://shipping-documentation.despatchcloud.app/books/api-accounts/page/api-accounts) for setup instructions on creating an API account. Once you have set up an API account, you can retrieve the necessary "api-user" and "api-token" variables from there.
[](https://shipping-documentation.despatchcloud.app/uploads/images/gallery/2025-02/creating-an-api-account-gui-method.webp) #### **🔧 Configuring Postman Collection Variables** After obtaining your API username and token, set them up in Postman. Storing them as collection variables simplifies requests and eliminates the need for repeated entries. Since these keys are already included in the collection, update them as needed. 1. **Go to ‘Variables’** (centre of the screen when viewing the collection). 2. **Enter API Credentials**: - **Variable:** `api_url` → [`https://production.courierapi.co.uk`](https://production.courierapi.co.uk) - **Variable:** `api-user` → *(Your API username)* - **Variable:** `api-token` → *(Your API token)* 3. **Retrieve API Details**: - Find `api-user` under "API Accounts" → "API Account" column. - Find `api-token` under "Keys & Tokens" column. 4. **Click ‘Save’** (top-right corner). [](https://documentation.despatchcloud.com/uploads/images/webp/Shipping/Shipping_SG_Advanced_SettingGlobalVars.webp?t=1722349428) #### **📡 Creating an API Account (API Method)** Setting up an API account through the API interface is a simple process that enhances workflow efficiency, especially when collaborating with team members across different locations. 1. **Go to ‘Account & Management’** folder in Postman. 2. **Select ‘Create a New API User’.** 3. **Customise the Request**: Enter the `name` field (other fields are optional). 4. **Click ‘Send’** (top-right corner). 5. **Retrieve API Keys** from the response. 6. **Confirm API Account in Voila** under "API Accounts."**Click to Play or Pause the Video**
#### **Getting a List of Couriers** To view the available couriers along with their names and details, you can utilise this endpoint to access all pertinent information on how couriers are identified within the API and how to reference them later. ##### **Follow these steps:** 1. Expand the "Account & Management" folder, then select "List Couriers" from the left-hand menu. 2. Click "Send" to submit the request. 3. The request-response contains a list of available couriers. Each courier is identified by the string contained within the "key" attribute. #### **🚚 Retrieving a List of Couriers** Utilise this endpoint to obtain key details on courier identification within the API and how to reference them later. 1. **Expand ‘Account & Management’.** 2. **Select ‘List Couriers’.** 3. **Click ‘Send’.** 4. **View Response**: The list of couriers is displayed with unique keys. [](https://documentation.despatchcloud.com/uploads/images/webp/Shipping/Shipping_SG_Advanced_ListCouriers.webp?t=1722349428) #### 📜 **Displaying Required Courier Parameters** Before proceeding to install couriers, it's essential to understand the parameters and information they require for installation. You can easily accomplish this by following these steps: 1. **Expand ‘Account & Management’.** 2. **Select ‘Get Auth Rules’.** 3. **Modify URL** with the courier key: `{{api_url}}/API/couriers/v1/ENTER-YOUR-COURIER-KEY-HERE/register-auth-rules` 4. **Click ‘Send’.** 5. **View Required & Optional Parameters -** the request-response contains the required and optional keys and their expected values, whether strings, integers or dictionaries. [](https://documentation.despatchcloud.com/uploads/images/webp/Shipping/Shipping_SG_Advanced_GetAuthRules.webp?t=1722349428) #### **Installing a Courier Through the API** Now that you know the fundamentals of API user setup and couriers, let's guide you through creating your initial courier connection. Each API account can independently install couriers, ensuring that courier connections remain distinct to each account. This meticulous level of control empowers you to tailor your shipping configuration to the specific requirements of your business segments. ##### **To install a courier via the API, follow these steps:** 1. Expand the "Account & Management" folder, then navigate to "Register Auth" in the left-hand menu. 2. Adjust the request URL, such as replacing the courier name with your desired choice. In this demonstration, we'll install DHL. 3. Customise the request data according to the courier's specific requirements. You can refer to the previous section if you need guidance on this. 4. Click the "Send" button at the screen's top left corner. 5. Review the request response to determine whether the installation was successful or unsuccessful. 6. To view the newly installed courier, proceed to **Voila** and select "API Accounts" from the left-hand menu. 7. In the API account where you installed the courier, click the "View Registered Auths" button. 8. You can confirm that DHL is listed in the installed courier's section, indicating a successful installation process. #### 📦 **Installing a Courier via API** Now that you know the fundamentals of API user setup and couriers, let's guide you through creating your initial courier connection. Each API account can independently install couriers, ensuring that courier connections remain distinct to each account. This meticulous level of control empowers you to tailor your shipping configuration to the specific requirements of your business segments. 1. **Expand ‘Account & Management’.** 2. **Select ‘Register Auth’.** 3. **Modify Request Data** with the courier’s specific details. 4. **Click ‘Send’.** 5. **Verify Response** for success. 6. **Check Installed Couriers** in **Voila** under "API Accounts." [](https://documentation.despatchcloud.com/uploads/images/webp/Shipping/Shipping_SG_Advanced_RegisterAuth.webp?t=1722349428) #### **🤖 Creating Smart Rules** Smart shipping enables automated carrier selection based on predefined rules. 1. **Access the Smart Shipping Interface**. 2. **Create Rule Groups & Smart Rules** based on shipping parameters. 3. **Optimise Costs & Delivery Speeds** through automated courier selection. 📌 **For a step-by-step guide, check the** **Smart Shipping Documentation****.**