API的对话:检索并提交消费者生成的内容(CGC),检索您的产品目录和关于CGC的统计信息。
验证用户
对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息,请参阅对话API文档主页.
内容
(+显示
——隐藏)
使用作者的电子邮件地址验证作者身份。
概述
托管电子邮件身份验证可以在提交过程中使用,以确认内容提交者的身份。当用户第一次提交内容时,会收到一封包含链接的电子邮件。单击链接后,用户会被引导到一个登录页面,该页面回调API以确认其身份。此调用将获得一个加密的用户令牌,该令牌可用于后续的提交调用。根据客户机的配置,在提交确认调用之前,内容可能不会被接受。
例子
提交调用以验证用户身份
https:// (stg) api.bazaarvoice.com/data/authenticateuser。(格式)? ApiVersion = [latestApiVersion] authtoken =(价值)万能钥匙= [yourKey]
参数
的名字 | 描述 |
---|---|
(格式) |
回应格式(xml或json) 要求该字段在所有API请求中都是必需的。 |
ApiVersion |
API版本,例如5.4。 要求该字段在所有API请求中都是必需的。 |
Authtoken |
在用户的认证电子邮件中收到的认证令牌值。有关更多信息,请参阅hostedauthentication_callbackurl参数。 要求该字段在所有API请求中都是必需的。 |
万能钥匙 |
API密钥需要验证API用户和检查访问特定客户端数据的权限。 要求该字段在所有API请求中都是必需的。 |
响应格式
下面是通过HTTP POST提交表单后的响应示例:
{"Data":{}, "HasErrors":false, "Form":[], "FormErrors":{}, "TypicalHoursToPost":null, "SubmissionId":null, "Locale":"en_US", "Errors":[] "Authentication": {"User": " 4d5a94aed5f29abd6bf9000c7518d3ee7573657269643d30313662626566642d343233632d3466139332d65646666316249464945442664617465653d3230313230363132 "}}
响应的元素
的名字 | 描述 |
---|---|
身份验证 |
包含身份验证数据的部分 |
数据 |
节,其中包含按内容/主题类型分组的查询所匹配的所有数据。在每个数据部分中都有一个以id为键的对象映射 |
错误 |
如果查询语法错误或执行查询时出现问题,则填充Error部分而不是其他字段。 |
形式 |
节,其中包含字段和组引用的数组 |
HasErrors |
布尔值,指示响应是否有错误 |
错误代码
价值 | 描述 |
---|---|
ERROR_BAD_REQUEST |
认证令牌无效、缺失或用户已通过认证 |
认证用户的提交必须采用HTTP POST的形式。