What is an API Key?
An API key is a unique identifier used to authenticate requests between a user and a service. It acts as a security token, allowing applications to communicate securely with Kintsugi's services. API keys are crucial for controlling access, preventing unauthorized usage, and ensuring data integrity.
Why Do I Need an API Key?
API Keys serve several important functions:
Authentication & Security: Ensure only authorized users can access Kintsugi’s services.
Access Control: Restrict or grant different levels of access to applications.
Monitoring & Usage Tracking: Keep track of API usage for security and performance insights.
Automation: Enable seamless integration with other tools and services.
Accessing API Key Management
1. Go to Account Settings
Log in to your Kintsugi account.
2. Navigate to the Configuration tab
On the left side of the app screen, click on the Configuration tab
3. Access the API Key section
In the Configuration menu, locate and select API Keys.
4. Manage your API Keys
This will open the API key management tool, where you can view a list of your API keys. You can create new API keys or delete existing ones as needed.
Note: API keys are tied to an organization and stay active until either the key or the organization is deleted. You can create multiple keys for periodic rotation.
Creating and Deleting API Keys
How to Create an API Key
Click New button
Choose an option from the drop-down menu.
To save, simply click on the "Save" button.
Click the copy icon or the Manually Copy API Key button to copy the key to your clipboard. Verify that the key has been copied correctly before proceeding.
PRO TIPS:
- Save the API key in a secure location, such as password manager or an encrypted document.
- Do not share your API key with others or expose it in public repositories.
- Avoid storing the key in plain text files or codebases to prevent unauthorized access.
- Ensure you have stored the key safely, as it cannot be viewed again.After successfully copying and securing your API key, click Done to close the popup.
How to Delete an API key
Select the API key you wish to delete, then click the three dots located on the right side.
To remove the API Key from the list, simply click on "Delete API Key.
To finalize the deletion process, please click the red "Delete" button.
Important Notes
API keys are associated with an organization and remain active until they are manually deleted or the organization itself is removed.
You can generate multiple API keys, allowing you to rotate them periodically for security purposes.
Keep your API key private and do not share it with unauthorized users to prevent misuse.
By following the steps, you can securely manage API keys and ensure controlled access to Kintsugi’s products and services.