Understanding API Keys in DataHub

TABLE OF CONTENTS

• What Are API Keys?
• Accessing Your API Key in DataHub: 
• Role-Based API Key Visibility:
• Use Read-Only Permissions When Needed: 
• Additional Resources

What Are API Keys?

API keys are unique tokens that enable secure communication between applications, ensuring only verified users or systems can access specific resources. 

In DataHub, API keys are assigned to individual users, making them unique to each account. This feature allows specific actions performed via the API to be attributed to a single user, enhancing both security and traceability.

Accessing Your API Key in DataHub: 

To retrieve your API key in DataHub:

Log in to your DataHub account. Navigate to the Settings panel. Click on the API section.

Your unique API key will be displayed; copy it for use in integrations.

If needed, you can create a new API key by selecting Create API Key. This feature is useful for managing multiple integrations or when a key rotation is required to enhance security.

Role-Based API Key Visibility:

In DataHub, the visibility and management of API keys can vary based on user roles. This role-based system means that each API key is associated with a specific user account. 

Use Read-Only Permissions When Needed: 

API keys can be configured with read-only permissions, allowing data to be viewed but not modified. This is ideal for use cases where data access without changes is sufficient. 

For instance, read-only API keys can be used in the frontend of your app where DataHub acts as storage. Since API keys are exposed in the frontend, using read-only keys helps protect data while allowing features such as displaying stored front-page products. 

Additional Resources

For more information on DataHub, check out the following resources:

• How to integrate DataHub
• Overall manual of the Datahub module
• How to Create a Lookup Connection for DataHub

DataHub is just one of the tools we support!

To check the list of the tools and features we support please click here!

If you don't see your favorite tool on our list, please take the time and send us the request here to create an integration for you or UP-vote if it's already on the list :) 

We develop integrations based on the requests and up-votes :) 

We hope that this covers everything. If you have any further questions or need additional clarification please reach out to us via [email protected] or our chat widget!