API Keys
This page provides information on API keys, their status, and how to manage them.
Introduction
API keys are essential for accessing our API and ensuring the security and stability of your applications. By following a few simple steps on our platform, you can generate unique API keys tailored to your needs.
How to manipulate the API Keys
This section will help you create and manage your API keys.
We will cover how to:
generate an API key
copy it to clipboard
view all keys
deactivate a key
To execute any of these actions, please proceed to the API keys section within the Offsetdata Application by following these two steps:
All subsequent actions will lead you through the API keys workflows, assuming that you always begin by navigating to the API Keys section.
How to generate an API key
To generate API keys, please follow these steps:
Open the API key creation modal by clicking on the "Create API Key" button.
Populate the text field with your API key name.
For example, your API key name could be "pollution-data-api-key". A well-chosen name is descriptive and memorable.
You can generate up to 10 API keys to suit your requirements.
Click the "Create" button.
The API key will be generated internally and the hash will appear at the bottom of the modal.
How to copy an API key
To copy an API key hash to clipboard, please follow these steps:
Click on the "reveal" icon located on the far left side of the API key record:
This action will unveil the API key hash, displaying the actual hash instead of a series of asterisks.
Click the copy icon at the end of the API key hash as shown in the image below:
This action will copy the hash to your clipboard, allowing you to paste it wherever needed.
How to view all API keys
To view your API keys collection, simply navigate to the API section.
The view section will resemble the image below.
When viewing the list of your API keys, you will see the following information:
Reveal API key hash toggle button: The button that allows you to reveal the API key hash in order to be copied to clipboard.
API key name: The name that you selected when the key was created.
API key hash: This is the unique identifier generated internally by the Offsetdata Application.
Creation Date: The date when the key was created.
Active key status: Active keys are displayed in green and indicate that they are currently active and can be used to access our API.
Revoked (inactive) key status: Revoked keys are displayed in red and indicate that they are no longer active. These keys have been disabled and cannot be used to access our API.
How to revoke an API key
To revoke an API key click on the green toggle button located on the far right of the API key record, as shown in the image below.
The toggle button will change to red, and the status "Revoked" will be indicated on the API key card, as demonstrated in the image below.
Customizing API Keys
We understand the importance of easy identification and organization. That's why we allow you to customize your API keys with descriptive names. By assigning meaningful names, you can easily identify each key and reflect the purpose of your Web3 project.
Key Security and Revocation
It is crucial to maintain the security of your API keys. Please adhere to the following guidelines:
Do not share your API keys: We strongly recommend that you do not display your keys to anyone. Sharing your keys can compromise the security of your applications and may result in unexpected billing.
Revoke keys when necessary: You have full control over your API keys and can revoke them at any time. If you suspect unauthorized access or need to restrict access for any reason, you can revoke a key to disable it immediately.
TL;DR
API keys are a fundamental aspect of accessing Offsetdata's API securely. By following the guidelines outlined in this documentation, you can generate, customize, and manage your API keys effectively. Remember to keep your keys secure and use them only for their intended purposes to prevent misuse.
If you have any further questions or need assistance, please refer to our additional documentation or contact our support team.
Last updated
