This article provides a step-by-step guide on how to manage API keys within the Gelato Dashboard, empowering you with the control you need over your API access.
Access and Permissions
Only admins or users with enabled permissions can access and manage API keys.
Managing Your API Keys
The Gelato Dashboard allows you to manage your API keys effectively. Here's how:
Log in to your account on the API Portal.
From the left menu, navigate to Developer > API Keys.
This page will display all your keys, along with their current status.
Adding a New Key
While on the API Keys page, locate and click on the Add API key button situated in the top-right corner.
Provide a unique name for your new key.
Click the Create key to generate your API key.
A newly generated key will appear. Ensure to copy and store this key securely. You can use the dedicated copy button for this purpose. Remember, once you navigate away from this page, the key won't be visible again.
Deactivating and Removing a Key
Before removing a key, you need to deactivate it.
Go to the API keys page.
Find the key you want to deactivate.
Click on the three-dot button next to the key.
Choose Deactivate. This will change the key's status.
Once deactivated, you can remove the key:
From the same three-dot menu, select Delete.
The key will be permanently deleted from your list.
Replacing an Existing Key
To replace an active API key, follow these steps:
Create a new key using the steps outlined in the "Adding a New Key" section.
Update your system to use the new key.
Verify that orders are being processed correctly with the new key.
Deactivate the old key following the deactivation steps mentioned earlier.
Double-check that orders are still going through successfully.
You can now delete the old key if you wish.