We'll walk you through the process of creating, managing, and using API keys for authentication. API keys are composed of a Client ID and a Client Secret.

These credentials can then be used to obtain an Access Token.

📘

Creating credentials

You will need access to a Mention Me account to setup Client Credentials. Speak to the owner of your Mention Me account to gain access - or reach out to our support team if you need help.

Creating an API Key

There's a few simple steps to put together an API key.

1. Visit the API pages in Settings for your Merchant

   

   

2. From here, click on "Create API key" to setup your first key.

   

3. Choose a name and enter a description. These are useful prompts in the future if you're trying to remember where this API key has been deployed.

4. Choose the scopes for the API key. We recommend granting as few scopes as possible to limit security risks. Each API in our API Reference describes the scopes it requires.

   

5. Once you create your Client ID and Client Secrets, it'll be presented to you and can be used to gain an access token.

   

6. Jump into the API reference and start making your first API call 😀

🔐 Security

The Client Secret and any access token should be kept securely. Ensure this it is securely stored and never exposed in client-side code or public repositories.

The Client Secret can only be viewed once during the creation process. If you lose it, you'll need to create a new key.