Getting your Bloomreach API, Secret and Project credentials

Learn how to retrieve your Bloomreach API credentials—including your API key, secret, and project token—from your Bloomreach portal dashboard to integrate with third-party applications.

Before you start

You'll need an active Bloomreach account with admin or appropriate access level to view and manage API credentials. Make sure you have permission to access the settings or account management section of your portal.

How to get your Bloomreach API credentials

  1. Log in to your Bloomreach portal at bloomreach.com with your account credentials.

  2. Once logged in, look for the settings or account management section. This is usually found in a menu or navigation area, often marked by a gear icon or a "Settings" link.

  3. Navigate to the "API" or "Credentials" section within your account settings. This section contains all the authentication tokens and keys you need for API access.

  4. In the credentials section, you'll see your API key displayed. This is a unique identifier used to authenticate your API requests.

  5. Your API secret (also called a secret key) will be listed alongside your API key. Keep this secure and never share it publicly.

  6. Your project token will also be available in the same credentials section. This token is used for specific project-level API operations.

  7. Copy each credential value and store them in a secure location, such as a password manager or secure notes application. Do not save them in version control systems or share them through unsecured channels.

Important security notes

Warning: Never expose your API secret in client-side code, public repositories, or unsecured communications. If your credentials are accidentally exposed, regenerate them immediately in your Bloomreach portal.

Tip: Different Bloomreach products (such as Discovery, Content, and Engagement) may have separate credential management interfaces. Make sure you're accessing the correct section for the product you're integrating with.

Note: Ensure you have the correct permissions level in your Bloomreach account to view API credentials. If you cannot access the credentials section, contact your account administrator.

Source: Search interface in Bloomreach documentation

Sources

This article was researched from the following documentation.

Documentation

← Back to Help Centre