API的对话:检索并提交消费者生成的内容(CGC),检索您的产品目录和关于CGC的统计信息。
升级指南
对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息,请参阅对话API文档主页.
内容
本文档提供了如何以及为什么升级到最新的对话API域和版本的指导。
介绍
升级提供了许多好处,包括访问新功能、bug修复和性能增强。
我们非常注重使新版本向后兼容。将大多数应用程序升级到最新版本不需要进行重大更改。
升级包括以下基本行动:
- 使用对话API通用域
- 切换到最新的对话API版本
- 修改您的应用程序需要考虑步骤#1和#2导致的更改
对话API通用域
以下域将适用于所有客户端,并应用于所有对话API请求:
环境 | 域 | 描述 |
---|---|---|
暂存 |
|
在开发应用程序时使用。 |
生产 |
|
在应用程序完成时使用。 |
请继续阅读,了解如何利用通用域的好处,即使您已经在使用域本身。
使用通用域的好处
- 向后兼容性
使用新的域不会改变响应体。
- 安全
通用域自动支持HTTPS,不需要额外收费。由于我们的CDN所施加的限制,一些较旧的域名无法使用HTTPS。
JSONP使用通用域的请求将得到验证,以减少跨站点脚本攻击的脆弱性。
- 速率限制报头
对使用通用域的请求的响应将包括标识您的速率限制和当前的利率,这是有用的,以避免利率限制。
- 真实性
较新的域支持
X-Forwarded-For
当从您的服务器提交到我们的服务器时,用于将作者IP地址通信到Bazaarvoice。这对于增加你的内容被考虑的可能性至关重要真实的.⚠根据Bazaarvoice真实性政策,您必须在每次投稿时附上作者IP地址。如果您未能在投稿时发送作者IP地址,Bazaarvoice可自行决定采取任何必要的行动以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。
最新的对话API版本
的值就可以简单地切换到最新的对话API版本apiversion
参数。
/数据/ reviews.json吗?apiversion = 5.4万能钥匙= kuy3zj9pr3n7i0wxajrzj04xo
使用最新版本的好处
- 向后兼容性
更改将在响应体中,但由于它们大多是附加的,许多客户端将不需要更新其应用程序,除非他们想利用新特性。请参阅显著的差异和更新日志更多细节。
- 安全
5.4之前的版本不提供安全的照片上传。
- 新功能
包括国际化、产品统计、基于电子邮件的认证、全文搜索、附加过滤器和排序等等。看到更新日志获取详细信息。
- 真实性
版本5.4及更高版本支持
《外交政策》
参数,用于将终端用户设备指纹传递给Bazaarvoice。这对于增加你的内容被考虑的可能性很重要真实的.⚠根据Bazaarvoice真实性政策,您必须在每次提交时附上设备指纹。如果您未能在提交时发送设备指纹,Bazaarvoice可自行决定采取任何必要的行动,以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。
显著的差异
5.4对话PRR & 5.4对话
对话PRR是我们平台的第一个版本。它已经被我们的新对话平台所取代,该平台提供了更高的性能、功能增强和对我们的自助服务配置中心的访问。新的对话平台支持对话PRR中最有价值的功能,同时消除了采用不佳或低价值的功能。对于访问Configuration Hub的客户端,2015年2月之后请求的API密钥将自动访问对话。
请参阅5.4(对话)更改日志查看差异列表,并了解API密钥与哪个平台相关联如何确定你的平台.
XML响应类型
对话平台上的API v5.4不再支持XML响应类型。无论您使用的是哪个API版本或会话平台,我们都建议您改用JSON。如果您无法做到这一点,您可以在PRR平台上使用带有API v5.4的XML,但请计划在未来切换到JSON。
除了上面提到的更改之外,对请求的响应使用. xml
更有可能发生变化. json
对应的版本在4.9到5.0之间。
进一步,对. xml
请求包含该版本的XML模式。XML模式在不同版本之间必然会发生变化。
使用XML响应升级应用程序的开发人员应该特别注意5.0更新日志.
5.0和5.1版本以及“隐含的语言环境过滤”
此差异仅会影响来自多个地区且尚未使用ContentLocale
过滤器。
版本5.0和5.1的API使用“隐含的语言环境过滤”,自动返回基于为客户端配置的默认语言环境的内容ContentLocale
过滤器用于请求特定区域设置。的类型将返回所有内容,而不考虑默认的本地ContentLocale
过滤器用于请求特定区域设置。
要保持前面的“隐含地区过滤”行为,添加filter=ContentLocale:{这里需要的locale}
对你的要求。
产品的家庭
从版本5.4开始,在按产品ID过滤时,默认情况下还会返回该产品的“产品族”中的所有内容。有一个新的excludefamily
参数,可设置为不返回产品族内容。
为了维护以前版本的行为添加excludefamily = true
对你的要求。
版本4.9
使用版本4.9的客户端在迁移到最新版本时应该会遇到最大的差异。因为4.9是第一个公开版本,所以后来版本的显示和提交响应包括许多更改和添加。使用4.9的客户机更有可能必须更新其应用程序以支持最新的显示和提交响应体。看到5.0更新日志下面是详细的列表。
样本迁移步骤
一般来说,开发人员可以执行类似于以下的步骤: