Overview

The key management process allows any member within a client instance to request API keys. However, requested keys remain inactive until they are explicitly enabled. To activate the requested keys, designated users with the Technical Administrator role must use the API key management application to approve and enable them for use within the client instance.

Prerequisites

Before you begin, make sure the following are in place:

• API access is enabled for your client instance. If not, contact your Bazaarvoice representative.
• Your Portal account has the Technical Contributor or Technical Administrator role. Learn more about roles in Bazaarvoice Knowledge Base. To check your role, contact your Account Administrator.
• Your Portal account is assigned the Ratings and Reviews solution. Learn more about permissions in Bazaarvoice Knowledge Base. To confirm your assigned roles, contact your Account Administrator.

Request API keys

To request API keys using the API key management application, follow the steps below:

1. Sign in to Bazaarvoice Portal.
2. If you do not have a Portal account, ask the Account Administrator listed in your profile to create one for you. To learn more, visit the Bazaarvoice Knowledge Base.
3. Select the required client instance name from the Instance Selector drop-down list in the upper-right corner.
4. Select Settings ⚙️ and then select API under the Developer section.
5. Select the Request API key button.
6. Select the Conversations API radio button and click Next.
7. Fill out the request form to request a new API key. After submitting, you will receive an email with the key details.
8. Register your application with Bazaarvoice. For Privacy API, Clients need to register their application for OAuth2 client credentials.
9. Wait for your Technical Administrator to approve the generated keys.

Approve API keys

After you request keys, your company's Technical Administrator must approve them. The keys are created in a pending state until they are approved manually. You can check the status of your request by viewing your keys in the API Key Management app in the Portal (Portal > Settings > API).

API key management permissions

Your ability to view, edit, approve, or request keys depends on your role in the Bazaarvoice Portal. Visit the Bazaarvoice Knowledge Base to learn about the actions each role can perform.

View API keys

Users can view only the keys they have permission for: as a Technical Contributor, you see only the keys you requested; as a Technical Administrator, you see all keys for the client instance.

ℹ️

Note:

A key in Pending state requires approval from a Technical Administrator.

To view the API keys in the Portal, follow the steps below:

1. Sign in to Bazaarvoice Portal.
2. Select the required client instance name from the Instance Selector drop-down list in the upper-right corner.
3. Select Settings ⚙️ and then select API under the Developer section.
4. In the API Keys section, use the filters to narrow down the list of keys based on API type, Project Name, Status, etc.
5. Use the search bar if you know the exact API key value to search for. You can use asterisks as wildcards. For example, searching for cAuS* returns all keys that begin with "cAuS". The search is case sensitive.
6. Use the sort functionality to order the keys by Project Name, Locked Status, Requester Name, and other options.
7. Select a key's Project Name to view the detailed information about the key.

Enable or disable keys

When users request keys, the account's Technical Administrator must approve them before they can be used.

To approve keys as a Technical Administrator, follow these steps:

1. In the API Keys section, use the Key details > Status filter to show only keys in the Pending state.
2. Select the required project name of the key to view its details.
3. Select Enable Key.
4. Select Save.

To disable a key, go to the same detail view and select Disable key instead of Enable key.