How to create API Key

When should I create a Cloudex API key?

Create a Cloudex API key when another system needs to exchange data with your Cloudex TMS account through the Cloudex API.

For example, an API integration can be used to:

• Import shipments/orders into Cloudex TMS from another system.
• Retrieve shipment statuses and milestones.
• Download documents such as PODs or CMRs.
• Export outgoing invoices to an accounting system.
• Export incoming invoices to an accounting system.
• Retrieve debtor information for a credit-management system.

Cloudex API Keys are used when an external system connects to Cloudex TMS.

If Cloudex TMS needs to connect to another TMS, use External TMS Credentials instead.

What should I know before creating an API key?

An API key is a security credential that allows another system to access Cloudex TMS through the API.

Only create an API key for a trusted integration partner or system, and share it only with the intended recipient.

IMPORTANT: Copy the API key before saving it.
After the API key has been saved, the key itself will no longer be visible in Cloudex TMS.

How do I create a Cloudex API key?

Go to: Your name → Settings → Integrations → Cloudex API keys

1. Click (+) New API key.
2. Fill in the required information in the API key form.
3. Copy the generated API key before saving.
4. Store the API key securely or send it securely to the integration partner who needs it.
5. Click Save.

Your integration partner can now use the API key to authenticate requests to the Cloudex API.

What if I forgot to copy the API key?

For security reasons, the API key is not displayed again after it has been saved.

Therefore, always copy the key before clicking Save.

Security recommendations

Treat an API key like a password.

Do not include API keys in screenshots, help documentation, public messages, or other places where unauthorized users could access them.

If an API key should no longer be used, it should be disabled or removed from Cloudex TMS.