Skip to main content

Best practices for storing your API Key

Updated over 2 weeks ago

Your API key is extremely sensitive and acts as the password to your account integration. Because we use a view once API key for enhanced security, you will only see the full key at the moment of creation.

Using Shopify, WooCommerce, Magento, or PrestaShop?

If you are using one of our out-of-the-box plugins, you only need to copy and paste your API key once during the initial setup. Our integration handles the secure storage of the key automatically, so you do not need to worry about the technical steps below.

How to secure your key:

Store it immediately: Copy your key to a secure password manager or secrets management system (like Vault or AWS Secrets Manager) right away. You will not be able to view it again in the dashboard.

Use environment variables: Never hardcode your API key in your application. Instead, access it via environment variables (e.g., process.env.API_KEY).

Keep it out of version control: Ensure files containing your key (like .env) are added to your .gitignore file so they are never published to public repositories like GitHub.

If you lose your key, you will need to generate a new one from the Developer section of your Dashboard.

Did this answer your question?