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

内容

+显示 ——隐藏

我们编译了一些提示,帮助您以正确的方式开始构建conversation应用程序。

阅读对话API使用条款

对话API使用条款是用简单的语言编写的,传达了重要的技术限制和要求,以及其他将影响如何构建对话API应用程序的术语。

帮助我们结束不真实的内容

在Bazaarvoice,我们相信真实的消费者生成的内容代表了作者对他们的产品或服务体验的真实、公正和透明的意见。我们希望所有的对话API应用程序都符合我们的真实性的政策。您可以学习如何增加您的内容被认为是真实的可能性真实性教程。

根据Bazaarvoice真实性政策,您必须在每次提交时附上设备指纹和作者IP地址。如果您未能在提交时发送设备指纹和作者IP地址,Bazaarvoice可自行决定采取任何必要的行动,以保护网络的完整性。此类行动可能包括但不限于:拒绝您的内容、停止在Bazaarvoice网络上聚合您的内容、撤销您的API密钥或撤销您的API许可。

实时提交内容

总是提交所有消费者生成的内容,只要你收到它Bazaarvoice。提交时间以内容提交到Bazaarvoice的时间为准。API没有提供包含替代提交时间的方法,这意味着没有立即提交到Bazaarvoice的内容将没有准确的提交时间。此外,修改或过滤您发送到Bazaarvoice的消费者生成内容违反了我们的使用条款和真实性政策。

每个应用程序都有一组API密钥

永远不要在多个应用程序之间共享API密钥。例如,在桌面网站和移动网站中使用相同的键。这有几个原因:

  1. 密钥用于跟踪API使用指标,因此共享密钥将合并应用程序流量。
  2. 如果您需要禁用和替换密钥,那么您将有更多的工作要做。
  3. 键具有速率限制,因此您将在多个应用程序之间共享该限制。

转义所有消费者生成的内容以防止XSS

在应用程序中显示用户生成的内容之前转义它是一种有效的方法跨站脚本(XSS)攻击,是构建安全应用程序所必需的。

我们没有预先转义API返回的内容,因为我们没有假设数据显示的环境,也没有假设API使用者希望它转义到什么程度。相反,您有责任对预期用例的数据进行适当的转义

开放Web应用程序安全项目(OWASP)提供了具体指导关于转义内容以防止XSS攻击。

注意对话API速率限制

Bazaarvoice平台是一个多租户系统,其中许多客户端共享相同的系统资源。必威投注网为了保护每个人的网络稳定,限制过度使用是很重要的。如果没有速率限制,构造不良的应用程序或不可预见的情况可能会对网络性能和可用性产生负面影响。

有关速率限制的更多信息,请访问速率限制教程。

利用缓存

缓存会话API数据可以提供许多好处,包括减少需要发出的HTTP请求的数量,从用户的角度加速应用程序,降低成本,帮助您避免速率限制问题等等。

阅读我们的缓存教程了解更多关于缓存的好处和几种常见的缓存技术。

提交时使用'Locale'参数

语言环境参数告诉我们的系统用什么语言编写内容。我们的系统使用这些信息将内容发送给我们的人工审核员。没有语言环境参数,我们的系统默认为英文,这将导致非英文内容被拒绝,因为处理它的版主将无法阅读它。即使你的内容是英文的,它仍然是一个很好的实践使用语言环境参数,因为这样做可以明确您的意图,并在需要时更容易本地化应用程序。

国际化教程中有关于语言环境参数。

最大化您的投资回报率与BV像素

通过实现BV Pixel(我们的API分析解决方案),您将获得Bazaarvoice转换影响报告(ROI报告)以及流量报告和分析。通过阅读BV像素教程。

定期重新构建数据存储副本

Bazaarvoice是对话数据的主要数据源。如果您想维护自己的副本,则必须至少每两周刷新一次。这降低了副本与Bazaarvoice主数据存储不同步的可能性。

我们提供了几个迭代对话API结果的替代方案,以使这更容易:

下一个

如果你还没读过,请仔细阅读开始部分。

中的每一节展开,以熟悉文档的其余部分左侧导航