Your BrandMentions API key is a unique, secret credential that you use to authenticate requests to the BrandMentions API. It works like both a username and a password in one string of characters, so it is very important to keep it safe.
Unlike some tools where keys are generated directly in the interface, BrandMentions API keys are issued by the BrandMentions team after you request API access.
How you get your BrandMentions API key
1. Make sure your plan includes API access
Before you can receive an API key, your account must:
Be on a plan that includes API access
Have API access enabled by the BrandMentions team
If you are not sure whether your plan includes API access, see the related help articles or contact support for confirmation.
2. Request API access from the BrandMentions team
If your plan supports API access, or you decide to upgrade to a plan that does, the next step is to request API access.
You can do this by contacting the BrandMentions team through:
Email
Your usual sales or support contact
In your message, it helps to include:
Your name and company name
The email address associated with your BrandMentions account
A short description of how you plan to use the API
This information allows the team to confirm that your account is eligible, enable API access, and prepare your key.
3. The BrandMentions team generates and sends your API key
Once API access is approved, the BrandMentions team will generate an API key for your account and send it to you directly.
Your API key will usually look like a long string of letters and numbers.
By following these steps and best practices, you can use your BrandMentions API key safely and reliably in all your integrations and automations.