Link to our API Documentation: https://www.taicloud.net/PublicApi/swagger/index#/
How to Obtain an API Key
To generate an API Key, a user with TMS Site Admin permissions must navigate to the Public Authentication Keys page under LSP. From there, you can assign an API Key that will be automatically generated for any Customer or Broker Staff.
The public authentication key provides a secure way to identify yourself to a login server without the need to type a password. You can generate one by following these steps:
1. Navigate to LSP > Public Authentication Keys.
2. Click Add Public Authentication Key button, then select an organization or customer in the Organization field and choose a customer staff or broker staff in the Staff field. Click the save button. The key will automatically generate and appear in the Authentication Key column.
To disable a key that is no longer needed, click the pencil icon to edit the key, update the Active column field to "Inactive," and then click the green checkmark to save the changes.
Customer Staff Keys
Keys assigned to Customers/Customer Staff can be shared with the intended recipient. Any rating performed using these keys will adhere to the margins configured in the TMS for that specific customer.
Broker Staff Keys
For keys assigned to Broker Staff, additional steps are required if the key will be used for rating. Broker Staff Keys allow access to all customers; for this reason, a Reference Number must first be assigned within the intended customer profile, and this Reference Number must then be included in each rating request to accurately identify the intended customer.
- Go to the Customer Profile you want to enable this rating option for.
- Once there, click on Edit Record. In the General Information section, enter a unique value in the Reference Number field.
- Share the Broker Staff API Key with the intended recipient.
- Ensure that the assigned Reference Number is included in every request under the CustomerReferenceNumber field.
{"AuthenticationKey": "string","OriginZipCode": "string","OriginCountry": 1,"DestinationZipCode": "string","DestinationCountry": 1,"Commodities": [{"HandlingQuantity": 0,"PackagingType": 120,"Length": 0,"Width": 0,"Height": 0,"WeightTotal": 0,"HazardousMaterial": false,"PiecesTotal": 0,"FreightClass": 0,"NMFC": "string","Description": "string","AdditionalMarkings": "string","UNNumber": "string","PackingGroup": 0}],"WeightUnits": 0,"DimensionUnits": 0,"AccessorialCodes": ["string"],"LegacySupport": false,"CustomerReferenceNumber": "string"}
Both options will return rates based on the current margins configured in the TMS for the specified customer, whether using the Customer Key or the Customer Reference Number provided in the request.
Note: Whether a Customer or Broker Staff Key is used for rating, only tariffs with the 'Display in Front Office' setting enabled in the Tariff Profile will be included in the results.
Keys for Integration Partners
In some cases, integration partners may require an API Key to be generated and shared with them. While it’s possible to use an existing LSP Staff profile to generate a Broker Staff API Key, we recommend creating a new LSP Staff profile specifically for the integration partner. This approach ensures better identification and organization. For example, when integrating with Parade, you could create an LSP Staff profile named 'Parade API' and use that profile to generate the necessary API Key.
Role of Permissions with Broker Keys
When using Broker API Keys, it’s important to consider the permissions associated with the LSP Staff profile. These permissions dictate what data the API Key can access. For example, if the API Key is used to retrieve accounting information from the TMS, the LSP Staff profile tied to the Broker Key must have the relevant accounting permissions enabled for the key to retrieve the data successfully.