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 page has basic steps to help you to fix some common issues encountered when using the Response API. Many issues can be fixed by following the steps below.

General troubleshooting steps

Begin by performing the following steps:

  1. Determine the API request being made
    • You may need to review your application code, refer to your application logs, or monitor the network traffic being generated by your application to see the exact request being made.
  2. Reproduce the issue
    • Now that you have the API request you can reproduce the problem. Use an API troubleshooting tool, like PostMan or Curl, that will allow you to see the request and response.
  3. Look for an error message in the response
    • Many errors will return a descriptive error message in the response body. You can see some examples in the section below, and the Reference Documentation lists specific errors for each content type.
  4. Process of elimination
    • Experiment with your request by removing a section and then making the request again. For example, if you remove a parameter and the request works, you know the error is related to that parameter.

Error-specific troubleshooting tips

This section shows common errors and solutions.

Description

The Response API passkey is passed in the query string. passkey=xxxxxxxxxxxxxxxxxx. If there is an issue with the passkey value, the API will respond with a HTTP 403 code. The response body will contain the message:

                        <h1>Developer Inactive</h1>
                    

Solution

Start by looking up your API key. This can be done in the Developer Portal by hovering over your user name in the top right and selecting the My Keys link. Then review the possible issues below:

  • You are using a staging key for production, or vice versa. Refer to Getting Started to learn about the supported environments.
  • There is a typo in your key. Confirm you are using the correct value.
  • Your key has not been approved yet. Refer to Key Request Process to learn more.
  • Your key was initially not approved, but may be now and you are getting a cached response. Try changing your request to see if you get a valid response.
  • If you know your key was recently requested or approved, please wait up to 5 minutes to ensure the most of up-to-date key status has propagated throughout our network

Description

The API request returns a HTTP 403 code, with the following response body:

                {
                    "httpCode": 403,
                    "requestURI": "{path}",
                    "errors": [{
                        "code": "OAUTH2_INVALID_ACCESS_TOKEN",
                        "field": "Authorization",
                        "message": "Invalid access token"
                    }]
                }
                

Solution

There was an error in the "Authorization" header key/value pair. Make sure the header value is in the form depicted below, where ACCESS_TOKEN is the Access token value acquired from the Oauth2 API:

Authorization: Bearer ACCESS_TOKEN

Description

Your request receives an HTTP 415 code, with the following response body:

                {
                    "httpCode" : 415,
                    "requestURI" : "{path}",
                    "errors" : [
                        {
                            "code" : "INTERNAL_SERVER_ERROR",
                            "field" : "",
                            "message" : "HTTP 415 Unsupported Media Type"
                        }
                    ]
                }
                

Solution

Make sure the 'Content-Type: application/json' is included in the header. This is only applicable when update client response and create client response.

Description

Your request receives an HTTP 409 code, with the following response body:

                {
                    "httpCode": 400,
                    "requestURI": "{path}",
                    "errors": [
                        {
                            "code": "INVALID_PROPERTY_VALUE",
                            "field": "response",
                            "message": "Duplicate '{response}' detected for ClientResponse.response"
                        }
                    ]
                }
                

Solution

Modify the response text or do not submit the client response.

Description

Your request receives an HTTP 400 code, with the following response body:

               {
                    "httpCode": 500,
                    "requestURI": "/contentmanagement/v1/clientResponses/{client}/reviews/{reviewId}",
                    "errors": [
                        {
                            "code": "INTERNAL_SERVER_ERROR",
                            "field": "",
                            "message": "Could not retrieve review for {client}:{reviewId}"
                        }
                    ]
                }
                

Solution

Check the client value in the request path and make sure you have access. This is only applicable when creating a new client response and getting all client responses for a client review.

Still having trouble? Contact us for assistance.