响应API:使用安全的HTTP接口以编程方式创建、读取、更新和删除对评论的响应。
阅读客户端响应
Bazaarvoice Response API允许您以编程方式管理评论响应。要了解更多信息,请参阅Response API文档主页.
内容
(+显示
——隐藏)
本页介绍如何:
- 获得特定的客户评审响应
- 获取给定评审的所有客户响应
获得特定的客户评审响应
通过使用资源的GUID将请求限定在特定的资源上。
请求
需要HTTP GET。
https:// (stg) api.bazaarvoice.com/response/v1/clientResponses/{responseGuid}万能钥匙? ={RESPONSE_API_PASSKEY}HTTP/1.1 Authorization: holder {ACCESS_TOKEN}…
旧的应用程序可能正在使用
https:// (stg) api.bazaarvoice.com/contentmanagement
作为响应API的基URL,而不是https:// (stg) api.bazaarvoice.com/响应
.的contentmanagement
URL已弃用。但是,Bazaarvoice将继续支持使用contentmanagement
网址,直至另行通知。上面例子中的省略号(…)表示你的应用程序可能会生成其他头文件。
参数
的名字 | 描述 | 要求 |
---|---|---|
路径 |
||
responseGuid |
评审响应的向导。 |
是的 |
变量的名称 |
||
万能钥匙 |
响应API密码。 |
是的 |
头 |
||
授权 |
授权值将由字符串组成 |
是的 |
响应
头
HTTP状态200表示成功。文件中记录了其他标头值概述.
身体
响应将在正文中包含一个JSON对象。下面演示了一个典型的客户端响应记录的成功GET:
{"data": [{"type": "clientResponse", "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "attributes": {"department": "某部门名称","response": "This is a sample client response.", "responseBy": " OAuth Application owner name", "responseSource": "为OAuth创建的应用程序名称","created": "2018-06-22T19:55:03Z", "updated": "2018-06-22T19:55:03Z"}, "relationships": {"author": {"data": {"type": "author"}, "id": "Dav OAuth"}, "links": {"self":"https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/relationships/author", "related": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author"}}, "review": {"data": {"type": "review", "id": "75266", "clientName": "{}"}, "links": {"self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/relationships/review", "related":"https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/review"}}}, "links": {"self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}}], "links": {"self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/{client_name}/reviews/{reviewId}?passkey={RESPONSE_API_PASSKEY}"}}
响应体中返回的键/值的定义记录在概述.
这两个responseBy
和responseSource
响应中的值是从Bazaarvoice在提供对响应API的访问时创建的OAuth应用程序中获得的。
内的内容的关系
节点的一部分JSON API规范.
错误
请参阅故障排除查看响应API错误的详细描述和解决方案。
获取给定评审的所有客户评审响应
通过使用reviewId将请求限定为特定的评审资源。
需要HTTP GET。
得到https:// (stg) api.bazaarvoice.com/response/v1/clientResponses/{客户}/评论/{reviewId}万能钥匙? ={RESPONSE_API_PASSKEY}HTTP/1.1 Authorization: holder {ACCESS_TOKEN}…
旧的应用程序可能正在使用
https:// (stg) api.bazaarvoice.com/contentmanagement
作为响应API的基URL,而不是https:// (stg) api.bazaarvoice.com/响应
.的contentmanagement
URL已弃用。但是,Bazaarvoice将继续支持使用contentmanagement
网址,直至另行通知。上面例子中的省略号(…)表示你的应用程序可能会生成其他头文件。
请求
参数
的名字 | 描述 | 要求 |
---|---|---|
路径 |
||
reviewId |
要附加到响应的评审的标识符。 |
是的 |
变量的名称 |
||
万能钥匙 |
响应API密码。 |
是的 |
头 |
||
授权 |
授权值将由字符串组成 |
是的 |
响应
头
HTTP状态200表示成功。文件中记录了其他标头值概述.
身体
响应将在正文中包含一个JSON对象。下面演示了一个典型的客户端响应记录的成功GET:
{"data": [{"type": "clientResponse", "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "attributes": {"department": "某部门名称","response": "This is a sample client response.", "responseBy": " OAuth Application owner name", "responseSource": "为OAuth创建的应用程序名称","created": "2018-06-22T19:55:03Z", "updated": "2018-06-22T19:55:03Z"}, "relationships": {"author": {"data": {"type": "author"}, "id": "Dav OAuth"}, "links": {"self":"https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/relationships/author", "related": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/author"}}, "review": {"data": {"type": "review", "id": "75266", "clientName": "{client}"}, "links": {"self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/relationships/review", "related":"https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/review"}}}, "links": {"self": "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}}, {..... .}, {.....}, {.....}]}
响应体中返回的键/值的定义记录在概述.
错误
请参阅故障排除查看响应API错误的详细描述和解决方案。
错误的API密码
<标题>开发者不活跃的h1 > < /
坏记名令牌
{"httpCode": 403, "requestURI": "/response/v1/clientResponses/{client}/reviews/{reviewId}", "errors": [{"code": "OAUTH2_INVALID_ACCESS_TOKEN", "field": "Authorization", "message": "Invalid access token"}]}
错误的客户端名称
{"httpCode": 500, "requestURI": "/response/v1/clientResponses/{client}/reviews/{reviewId}", "errors": [{"code": "INTERNAL_SERVER_ERROR", "field": "" message": "Could not retrieve review for {client}:{reviewId}"}]}