Introduction
Velo's Secrets Manager allows you to securely store API keys and other secrets on your site. Each secret's value is encrypted, and assigned a name of your choice and an ID. You can then use the name or ID to refer to the secret in your backend code rather than hardcoding its value.
Learn more about Velo's Secrets Manager.
With the Secrets API, you can safely:
- Manage secrets.
- Retrieve secret values.
- Retrieve other information about your secrets, such as their names and descriptions.
To use the Secrets API, import wixSecretsBackend from the wix-secrets-backend module:
javascript | Copy Codeimport wixSecretsBackend from 'wix-secrets-backend';
Learn more about the Wix Secrets API in Secrets Manager in the Velo API Reference, and on Wix Learn.
Before you begin
It's important to note these points before coding:
- You must set up a Members Area, before you can create or manage secrets with the Secrets API.
The Members Area isn't required to retrieve secrets with
getSecret(). - Deleting a secret, or modifying a secret's name or value, breaks all code using the secret.
- You can't create or rename a secret with a name that's already in use.
Security considerations
- If you currently use private keys in your code, we recommend removing them. You can either create a secret with the Secrets API or the Functional Testing tool.
- To prevent malicious users from accessing the values of your secrets, use them only in backend code. Avoid using secret values in client side code.
Terminology
- Secret: Secrets are values that you don’t want to be publicly accessible, such as login credentials or API keys.
- API key: An API (Application Programming Interface) key is a unique code used to authenticate a user or program when making a call to an API.
Was this helpful?