Skip to main content

How to add a carrier TMS API key?

Add a carrier's TMS API key when Cloudex TMS needs to send transport orders or other information directly to the carrier's external TMS.

For example, if your carrier uses XSPED or Terminality, their API credentials must be registered in Cloudex TMS before you can send orders to their system via API.

Note: This is not a Cloudex API key.
Here you enter API credentials provided by the carrier or their TMS provider.

When do you need this?

You need to add carrier TMS credentials when:

  • the carrier uses an external TMS supported by Cloudex TMS;
  • you want to send transport orders directly from Cloudex TMS to the carrier's TMS;
  • the integration requires API authentication provided by the carrier.

If the carrier also uses Cloudex TMS, you normally do not need to enter an external API key. Cloudex recognizes the Cloudex-to-Cloudex connection automatically.

Before you start

Ask the carrier or their TMS provider for the API credentials required for the integration.

You will also need to know which carrier in your Partners list the credentials belong to.

How to add the carrier TMS API key

Go to: My Profile → Settings → Integrations → External TMS credentials

image.png

  1. Click Add.
  2. In Partner, select the carrier whose TMS credentials you are adding.
  3. In Type, select the carrier's TMS system.
  4. In API key, enter the API key provided by the carrier or their TMS provider.
  5. Click Save.

The credentials are now linked to that carrier.

image.png

What happens after the API key is added?

When you select this carrier in Trip/Spedition, Cloudex TMS can recognize that an external TMS integration is configured.

If the integration supports sending transport orders, the Send order to carrier function becomes available.

You can then send the transport order directly from Cloudex TMS to the carrier's TMS without manually entering the same order in another system.

Cloudex API key vs. External TMS credentials

These two settings are used for opposite integration directions:

Setting Direction Who provides the API key?
Cloudex API keys External system → Cloudex TMS Cloudex TMS
External TMS credentials Cloudex TMS → External TMS Carrier / external TMS provider

Use Cloudex API keys when another system needs access to Cloudex TMS.

Use External TMS credentials when Cloudex TMS needs access to another TMS.

  • How to send an order to a carrier via API?
  • How to create API key
  • How to receive statuses and documents from a carrier via API

No comments to display

Back to top