Skip to main content

How to find your Denim API Key

  • Updated

In this article, you will learn

 

What is the Denim API Key?

An API key allows Denim and other systems (such as a TMS that is integrated with Denim) to communicate securely. This API Key serves as your password—keep it private and share it only with the people whom you trust, and for specific reasons only.

 

____________________________________________________________________________

Options to access the API Key settings

_____________________

Left side navigation

Click on Settings in the navigation. 

 

The Settings shows its own navigation on the left side.

 

________________________________

In the user profile menu at the top

Click on the user profile image at the top. A menu opens. 

Click on Settings.

 

 

In either case, the Settings show its own internal navigation in the left side.

Click on API Access and the API Access page opens, as shown below.

 

💡 Note: Make sure you have access to the API Integrations. Go to your My Account or Settings page to request your account be activated for integrations.

 

_______________________________

Generate the API Key

To generate an API Key, click on the Generate API Key button. 

The API Key is generated and defaults to hidden for security reasons. 

 

For this Key, there are different actions available to you—View, Copy, and Change.

View: Click on the View button to see the Key in readable form. The View button changes to Hide button now. Click on the Hide button to keep it in the encrypted form for security reasons.

Copy

Click on the Copy button to copy the API Key to your clipboard. You may need it to paste the API Key somewhere in an external service. 

 

_______________________________

Change the API Key

You have the option to change the API Key if required. For example, if you change TMS providers, or if you sense that the API key is compromised, you change the API Key.

  1. Click on the Change button.
  2. Click on the Save button to save the new API Key.

⚠️ Caution: If you change your API Key, your old API Key is disabled immediately, and all the services that are integrated using that old key stop functioning immediately.