The Bazaarvoice Response API lets you programmatically manage review responses. To learn more, go to the Response API documentation home page.

Contents

(+ show- hide)

This section contains information that will get you started using the Response API quickly and correctly.

Response API

The Response API presents a “REST” style HTTP interface that exposes three resources: Authors, Reviews, and Client Response. The Client Response allows you to manage responses to reviews, while both Authors and Reviews support the JSON API specification.

Required Credentials

To use the Response API, you will need the credentials described below. Refer to the Getting access section to learn how acquire these credentials from Bazaarvoice.

Credential Description
Response API passkeys

These values, one for staging and one for production, will be used in every request to the Response API.

OAuth2 API passkeys

These values, one for staging and one for production, will be used in every request to the OAuth2 API. They will be identical to the Response API passkeys. Refer to OAuth2 Integration for more information.

Client ID This value will be used in every request to the OAuth2 API. Refer to OAuth2 Integration for more information.
Client secret This value will be used in every request to the OAuth2 API. Refer to OAuth2 Integration for more information.

Getting Access

Because the Response API allows clients to provide feedback directly to content in a review, we have implemented OAuth2 to ensure that only authorized personnel have access. The steps for getting access are described below.

Steps

Developers will need to perform the following steps to use the Response API:

  1. Create a Developer Portal user account

    You will need a Developer Portal account to use the Response API. An existing account can be used or you can create one using the “Register” link at the top right. Make note of the email address associated with this account, because you will need it when registering an application.

    You must create an Developer Portal account before registering an application to use the Response API.

  2. Register an application with Bazaarvoice

    To use OAuth you must register an application with Bazaarvoice. This is the application you build that will use the Response API. Refer to OAuth2 Integration for more information.

    When you register an application we will create a user with staging access for you to use while developing your application.

    Continue to the Register an application below to learn more.

Additional step for non-developers

Only authorized users registered with our Client Portal will be able to initiate Response API requests in production.

Before an application is used in production, someone from the organization that owns the data will need to be given production access to the Bazaarvoice client portal.

Register an application

Contact our Support team at https://support.bazaarvoice.com to request Response API access.

Copy/paste the template below into your support case and then manually replace the <PLACE_HOLDER> tokens with the appropriate information or click here to use an interactive template generator and then copy/paste the completed template into your support case.

Refer to the table below for information about each value. All values are required.

Please register an application for use with the Response API.

DEVELOPER PORTAL USER EMAIL ADDRESS: <EMAIL_ADDRESS>
DEVELOPER COUNTRY: <DEVELOPER_COUNTRY>
CLIENT INSTANCE NAMES: <NAME_1>, <NAME_2>, <NAME_N>

APP DISPLAY NAME: <DISPLAY_NAME>

APP DESCRIPTION:
<DESCRIPTION>

REDIRECT URIS:
<URI_1>
<URI_2>
<URN_N>

Thanks,

<SIGNATURE>
The email address associated with your Developer Portal account.
The country where the developer is located.
This determines to which client's data your keys will have access. Use the name(s) used to log into the Bazaarvoice Client Portal (aka: Workbench).
A human readable name that will be displayed to users when they grant access to you application. Refer to OAuth2 Integration for more information.
A brief explanation of how this application will be used.
One or more complete URLs to a resource implemented by your application. Refer to OAuth2 Integration for more information.
Cancel
Developer Portal user email address

This is the email address associated with a Developer Portal account. You must have an account prior to registering an application to the Response API.

Developer country

The country where the developer is located.

Client instance names

This determines to which client's data your keys will have access. Use the name(s) used to log into the Bazaarvoice Client Portal (aka: Workbench).

Ex: acme-en_us, acme-fr_fr

App Display Name

This is a human readable name that will be displayed to users when they grant access to your application. Refer to OAuth2 Integration for more information.

Ex: Acme Response App

App Description

A brief explanation of how this application will be used.

Ex: App for Sales Force integration.

Redirect URIs

One or more complete URLs to a resource implemented by your application. One per line. Refer to OAuth2 Integration for more information.

https://dev.example.com/response/app
https://stg.example.com/response/app
https://www.example.com/response/app

Next Steps

Continue to OAuth2 Integration to learn how to use 3-legged OAuth with the Response API.

Go to the Reference section to learn more about using the Response API.