README

此 Contao 捆绑包用于（自动）收集和输出客户评价。

功能

评价将以徽章的形式展示。徽章通常在页面的固定位置显示，包含 Logo、平均星级评价和客户评价数量。点击徽章将显示包含 x 个评价（可配置）的列表，以及一个链接到所有评价的页面。

徽章可以被关闭。这将被存储为 Session-Cookie。当浏览器关闭并重新打开时，徽章将再次出现。

为了能够提交评价，必须邀请“客户”。在此过程中将生成一个令牌，使客户可以提交一次评价。邀请可以通过表单发送，或者通过 ReviewsService->sendLink(...) 自动化发送，或者通过 API（见下文）

评价将按类别收集。在一个多域名安装中，这可能是不同的网站——因此可以为每个网站（页面树）收集不同的评价。

评价必须在成功提交后由管理员激活，并且也可以在此（在后端）进行评论。

在 Notification Center 中设置一个网关（如果尚未设置）
在 Notification Center 中创建两个通知。一个为“评价链接”类型。此电子邮件将被发送给访客/客户。收件人可以填写为 ##recipient_email##。用于评价表单链接的是 Simpletoken ##link##。第二个通知是“评价管理员邮件”类型。当评价成功提交（但尚未发布）时将发送此通知。可以通过直接点击链接 ##link## 来启用通知。此外，还有 Token ##user##、##rating##、##review## 和 ##category## 可用。
需要以下页面
- 评价 - 发送链接（用于手动发送邀请）
- 评价 - 表单
- 评价 - 列表
- 评价 - 已提交
- 评价 - 错误/无效令牌
- 评价 - 成功
在内容/评价下创建一个“类别”
- 选择“评价 - 表单”页面
- 选择通知
创建以下模块
- 评价徽章（重定向到“评价列表”页面，选择 Logo，指定点击徽章时显示的评价数量）
- 评价表单（在令牌错误/过期或成功提交评价后重定向到指定的页面）
- 发送评价链接（指定创建的类别）
- 评价列表（选择类别，指定每页显示的元素数量）
将模块安装在先前创建的页面上
在页面布局中安装徽章模块（最好放在页脚）
在页面布局中激活 CSS（如有需要或用于测试）

以JSON格式发送POST请求。API令牌必须在相应类别中创建，以便在评估中使用。

POST /api/reviews/sendlink
{
	"user": "API User",
	"email": "test@test.de",
	"category": 1,
	"apiToken": "ac43a85f-167c-41db-aa7b-7edb51d6a55b"
}