Managing API keys

Required option: API / Integration
Allowed profile: Brand manager

The API page in your settings lets you create and manage the keys that connect external tools, such as an ERP or a BI tool, to your Le New Black data. This article explains how to create a key with the access you need, then revoke or delete it when it is no longer used.
 

• Creating an API key
• Revoking an API key
• Deleting an API key
   
   

Creating an API key

If you already use the API for an external integration, your existing key appears in the list as Historical key. Its permissions have not changed, and your integration continues to work as before. You can create as many additional keys as you need, each with its own access. For example, you can create a key for your BI tool that can only read data.

1. Go to the ⚙️ settings wheel > Settings, then select API in the ACCESS & SECURITY section.
    
2. Click Create a key.
    
3. In the Create a key window, enter a name in the Name field. Choose a name that identifies the tool that will use the key, such as "BI tool", so you can recognise it in your list.
    
4. Under APIs this key opens: select Wholesale API v2, Analytics API, or both.
    
5. Under Permissions, select the access level:
   • Read only: the key can read data only.
   • Read and write: the key can also create, update and delete data.
      
6. Click Create the key.
    
7. Click the copy icons next to Client id and Client secret, and store both values in your team password manager.
    
8. Tick I stored the secret in our team password manager then click Done.
   ⚠️ The client secret is shown only once. After you close the window, it cannot be displayed again. If the secret is lost, create a new key and revoke the previous one.

A confirmation message appears at the top of the page, and the new key is added to your list. To see who created a key, hover over its creation date. This information is not available for the Historical key.

Your developers or integrators can then use the client ID and client secret to connect to the API. You can also access the API documentation by clicking the graduation cap icon next to Create a key.

Revoking an API key

Revoking a key deactivates it. This is useful, for example, when you change ERP or when a person with privileged access leaves your company.

1. Click ⋯ next to the key.
2. Select Revoke.

A confirmation message appears at the top of the page, and the key is now greyed out and struck through in your list. Tools that use this key can no longer access your data. You can keep a revoked key in the list to retain a history of the keys used in the past.

Before revoking a key, you can check the LAST USED column to see whether it is still in use.

Deleting an API key

Only a revoked key can be deleted. If you do not need to keep its history, you can remove it from your list completely. Deleting a key is irreversible.

1. Click ⋯ next to the revoked key.
2. Select Delete.

A confirmation message appears at the top of the page, and the key is removed from your list.