DCE HTTP Service - v3
This page contains reference documentation for version 3 of the Displayable Content Export (DCE) HTTP service.
Environments
The DCE supports the following environments:
| Environment | Domain | Description |
|---|---|---|
| Staging |
|
Used while developing your application. |
| Production |
|
Used when your application is complete. |
Required headers
All DCE requests must include the following headers:
| Name | Description |
|---|---|
Host |
Environment, staging or production, that will process the request. ⚠ If you are getting 403 response from S3 then you may exclude Host from your header for the GET request of data sets from S3. |
X-Bazaarvoice-Passkey |
The passkey key described in the Credentials section. |
X-Bazaarvoice-Signature |
An access signature used to verify the request. This is created by the DCE user for each request. Refer to Creating the access signature for additional details. |
X-Bazaarvoice-Timestamp |
A Unix timestamp in milliseconds. DCE requests will be valid for 3600 seconds after the time stamp is created. Requests using an expired timestamp will return an error. |
Access signature
The contents of the message to be encrypted will vary based on the DCE request. The two possible variations are demonstrated below:
| Without path | passkey={DCE_PASSKEY}×tamp={TIMESTAMP} |
|---|---|
| With path | path={PATH_VALUE}&passkey={DCE_PASSKEY}×tamp={TIMESTAMP} |
The tokens above should be replaced with the appropriate values as described below:
| Name | Description |
|---|---|
{PATH_VALUE} |
This is the same value communicated in the path query string parameter. Refer to the Workflow Walk-Through for more information. |
{DCE_PASSKEY} |
This is the same value communicated with the |
{TIMESTAMP} |
A Unix timestamp in milliseconds. This is the same value communicated by the ⚠ Using seconds or any increment other than milliseconds will cause your request to fail |
Refer to Creating Access Signature for verification values and code examples.
Parameters
| Name | Description |
|---|---|
path |
The value identifying the DCE data set version in the form of a URL path segment. ⚠ The path value is provided by the DCE and must be used exactly as it is. Any modification will result in the DCE returning an error. |
Examples
Request manifest file list
Returns a JSON list of manifest file paths which will be used in the next request. Refer to the tutorial for detailed instructions.
Request
GET https://[stg.]api.bazaarvoice.com/dce/v3/data
Headers
Host: [stg.]api.bazaarvoice.com
X-Bazaarvoice-Passkey: {DCE_PASSKEY}
X-Bazaarvoice-Signature: {SIGNATURE}
X-Bazaarvoice-Timestamp: {TIMESTAMP}
Request manifest file
Returns a 302 redirect to a manifest file containing paths to UGC data files. Refer to the tutorial for detailed instructions.
Request
GET https://[stg.]api.bazaarvoice.com/dce/v3/data?path={MANIFEST_PATH}
Headers
Host: [stg.]api.bazaarvoice.com
X-Bazaarvoice-Passkey: {DCE_PASSKEY}
X-Bazaarvoice-Signature: {SIGNATURE}
X-Bazaarvoice-Timestamp: {TIMESTAMP}
Request UGC data file
Returns a 302 redirect to a file containing UGC data. Refer to the tutorial for detailed instructions.
Request
GET https://[stg.]api.bazaarvoice.com/dce/v3/data?path={UGC_DATA_PATH}
Headers
Host: [stg.]api.bazaarvoice.com
X-Bazaarvoice-Passkey: {DCE_PASSKEY}
X-Bazaarvoice-Signature: {SIGNATURE}
X-Bazaarvoice-Timestamp: {TIMESTAMP}
Following a 302 redirect
The DCE will return 302 redirects for some requests. This allows us to decouple the location of the data file from the DCE service path. It is essential that your application immediately follow the redirect exactly as it is provided and to not save or reuse redirects at a later time.
GET {REDIRECT_URL}
Refer to the tutorial for detailed instructions.
Error specific troubleshooting tips
Please see the Troubleshooting page.
Updated 9 months ago