搜索表单

API的对话：检索并提交消费者生成的内容(CGC)，检索您的产品目录和关于CGC的统计信息。

平台和API概念

对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息，请参阅对话API文档主页．

内容

（+显示 ——隐藏）

本页解释了使用对话平台和API需要了解的重要概念。

API请求的解剖

所有对对话API的请求都将包括以下组件:

http [s]: / /{环境}/数据/ {contenttype}, {json | xml} ? ApiVersion = {n n}万能钥匙= {apikey}
URL组件 描述

协议
http [s]

对话API同时支持http和https。我们建议对所有请求使用https。看到安全的要求下面是更多信息。

域
{环境}

此令牌将被替换为stg.api.bazaarvoice.com或api.bazaarvoice.com这取决于您希望为您的请求提供服务的环境。继续环境下面了解更多。

路径
数据

我们的CDN使用此部分将请求路由到会话API应用服务器。
{contenttype}

用于标识您希望请求或提交的内容类型。欲知详情，请浏览显示原理而且提交基础．
{json | xml}

对话API目前支持JSON和XML．

⚠使用xml是我们的对话API使用条款- 4.(d)(iii)并且对于2016年8月29日之后发布的API密钥已禁用。

查询字符串
ApiVersion = {n n}

确定哪个版本的API将处理您的请求。您应该始终使用最新版本。继续版本控制下面了解更多。
万能钥匙= {apikey}

API密钥用于识别应该返回哪个客户端数据，并用于跟踪和度量。要了解如何获得API密钥读取键请求流程．
除了上面列出的选项，对话API还支持许多其他选项。继续浏览显示原理而且提交基础部分了解更多。

安全的要求

当使用HTTPS协议进行安全请求时，将以安全方案返回以下资产:

  • Bazaarvoice-hosted照片
  • bazaarvoice托管的辛迪加归因值
  • YouTube url

其他资产，比如通过产品提要导入Bazaarvoice平台的资产，在发出安全请求时不会改变。例如，使用HTTP提供给Bazaarvoice的产品图片url将不会升级到HTTPS。

环境

对话API支持以下环境:

暂存
域 stg.api.bazaarvoice.com
描述

在开发应用程序时使用。提交到此环境的内容大约每15分钟自动发布一次。分期在实施上几乎与生产相同，但在规模上不同。请不要尝试在分段进行负载测试。
生产
域 api.bazaarvoice.com
描述

在应用程序完成时使用。提交到此环境的内容将在72个工作小时或更短时间内手动审核。请联系我们如果您希望针对生产进行自动化性能测试，例如负载测试或安全扫描。

版本控制

Bazaarvoice Conversations API是有版本的，所以我们可以发布新功能、bug修复和改进，而不会影响使用API的应用程序的稳定性。

这个表格显示了所有的对话API版本。

版本 发布日期 弃用日期 状态
β(PRR) 只邀请 2011年8月 弃用
4.9 (PRR) 2011年8月 2016年4月30日 弃用
5.0 (PRR) 2011年10月 2016年4月30日 弃用
5.1 (PRR) 2012年2月 2016年4月30日 弃用
5.2 (PRR) 2012年6月 2017年4月30日 弃用
5.3 (PRR) 2012年8月 2017年4月30日 弃用
5.4 (PRR) 2013年1月 待定 最新的
5.4(对话) 2016年8月 待定 最新的
弃用
不应期望这些版本返回数据和/或可能遇到服务降级。特定于这些版本的文档可能不再可用。Bazaarvoice将在弃用API版本前提前一年通知用户。
日落
已经宣布了这些版本的弃用日期。在那之前，它们将继续发挥作用。使用这些版本的应用程序应在弃用日期之前升级到最新版本，以确保继续使用功能。新的应用程序不应该使用这些版本。
活跃的
活动版本可以继续运行，但是使用这些版本的应用程序应该在可能的情况下升级到最新版本，以利用新特性和bug修复。新的应用程序不应该使用这些版本。
最新的
这是最新版本。特性开发主要集中在未来的版本上，但是我们可能会执行向后兼容的错误修复。新的应用程序应该使用这个版本．

请参阅升级指南而且更新日志以了解更多版本之间的差异。

平台

您可以使用的API特性取决于您的平台。对话PRR平台可以访问其中一些特性对话平台不可用。

对话PRR
这是第一个对话平台。最初称为“产品评级和评论”，后简称为“PRR”。在这个平台上，客户端配置是内部的，所有更改都必须由Bazaarvoice人员完成。此平台不适用于新客户端。
对话
对话是我们最新的平台。对于这个平台，我们专注于从之前平台的经验中学到的最佳实践。这个平台支持conversation PRR的新特性和最有价值的特性，同时消除了采用不佳或低价值的功能。在这个平台上的客户可以访问我们的自助配置中心，允许他们在不依赖Bazaarvoice人员的情况下查看并与他们的配置进行交互。

2013年年中之后的客户不太可能使用Conversations PRR，许多较老的客户已经选择迁移到Conversations。

如何确定你的平台

使用以下方法之一来确定您所在的平台:

按API键

在下面的字段中输入对话API密钥，以了解与该密钥相关联的平台。

⚠平台查询不可用。请尝试以下选择之一或联系我们Bazaarvoice的支持．

Bazaarvoice工作台

如果你有你的Bazaarvoice工作台，登录后执行以下步骤:

  1. 将鼠标悬停在顶部菜单中的“设置”上
  2. 如果你看到“管理应用程序”选项，那么你在对话
  3. 您可以选择“管理应用程序”来打开配置集线器

支持

联系我们的支持团队将能够告诉您您的客户端实例安装在哪个平台上。

特性可用性和配置

对话API公开了分布在多个平台上的大量特性。有九种以上的内容类型30种不同的字段类型．其中许多都是可配置的，这意味着它们的行为和属性可以因客户机而异。因此，您在Developer Portal中看到的特性可能需要额外的配置，可能需要在默认情况下启用，或者根本不可用。

我们知道，弄清楚可用的功能以及如何配置它们是具有挑战性的，所以我们提供了一些工具来帮助:

API提交响应

的方法，可以使用API本身来内省可用字段行动参数。欲知详情，请浏览提交基础教程。

API检查器

API检查器可以帮助您查看哪些字段可以提交。属性时，API检查器会发出请求行动参数，并在易于理解的GUI中显示结果。打开API检查器．

配置中心

如果您在对话平台上，您可以访问一个自助配置UI，允许您查看您的配置并与之交互。请参阅工作台部分以了解如何导航到配置集线器。

Bazaarvoice的支持

如果上面的选项不适合你，那么我们可以帮助．

未来的兼容性

我们正在考虑对话API的未来，我们希望你做好准备。本节将帮助您使用我们的对话API构建应用程序，从而更容易升级到未来的API版本。

在sessions API的上下文中，未来的兼容性意味着优雅地接受未来API版本生成的API响应。未来兼容的应用程序是指在迁移到更新的API版本时需要进行最小的代码更改的应用程序。

如何提高未来的兼容性

  1. 始终使用最新的对话API版本

    • 我们试图使每个API版本尽可能向后兼容以前的版本。通过使用最新版本，您可以增加应用程序与更新的API版本一起工作的可能性，或者至少将升级所需的工作降至最低。

      看到版本控制以上是更多细节。

  2. 即使你还在对话PRR平台上，也不要只使用对话PRR功能

    • 我们最新的对话平台不再支持对话PRR特性。您不应该期望它们在新的API发行版中可用。

      看到对话PRR只有功能一个完整的列表。

  3. 尽量避免使用我们计划在将来弃用的特性。这些特征用警告并且在未来的用法。

下一个