README

一个易于使用的包，可以将电子邮件营销解决方案 CleverReach® 集成到您的 Neos 网站中，通过注册表单直接将新订阅者添加到您的通讯录列表。

安装

安装的最简单方法是运行此命令

composer require kaufmanndigital/cleverreach

安装成功后，使用 OAuth 凭证配置您的 CleverReach® 凭证

您可以在 https://www.cleverreach.com/login (菜单 "我的账户" -> "REST API") 创建此类凭据。 您需要 REST API V3 的凭据。

KaufmannDigital:
  CleverReach:
    credentials:
      clientId: '<client-id>'
      clientSecret: '<client-secret>'

可选：如果您想使用 Ajax 提交表单，请在模板内部使用 <script src="{f:uri.resource(path: 'JavaScript/Main.js', package: 'KaufmannDigital.CleverReach')}"></script> 加载提供的 JavaScript（需要 jQuery）或创建自己的 Ajax 动作。

恭喜，您现在可以在 Neos 安装中使用 KaufmannDigital.CleverReach。

设置注册表单

为了将注册表单添加到您的网站，您必须 创建一个组（以及一个表单，如果您想使用 DOI）
目前这些步骤不能通过此包完成（请参阅计划中的功能）。因此，请访问您的 CleverReach 登录并按照那里的说明操作。

完成操作后，登录 Neos 并导航到您想放置注册表单的页面。
现在从列表中选择 "CleverReach 注册表单" NodeType 并将其插入您想要的位置。

之后，您可以选择用户将被添加到的组和用于双 Opt-In 的表单（如果已启用）

您基本完成了。只需尝试一下：使用 Neos 前端注册您的电子邮件并检查 CleverReach 的客户区域。

附加字段

CleverReach® 支持附加字段以存储有关订阅者的更多信息。请看这里
这些字段也由此包支持。要提交数据到这些字段，您需要进行一些自定义设置

在 CleverReach® 中创建附加字段。在此描述

如文档中所述，覆盖 NodeType 的模板解释如下

-
 requestFilter: 'isPackage("KaufmannDigital.CleverReach")'
 options:
   templateRootPaths:
     'KaufmannDigital.CleverReach': 'resource://Your.Package/Private/Templates/'

将自定义字段作为输入字段添加到自定义模板中
```
<f:form.input name="receiverData[attributes][custom-field]" />
```
或作为隐藏字段
```
<f:form.hidden name="receiverData[attributes][custom-field]" value="My Value"/>
```
对于 全局附加字段，只需将 attributes 替换为 global_attributes

订单

CleverReach® 还允许您与新订阅者一起提供订单信息。
为此，您必须如上述步骤 2 中所述覆盖模板。然后您可以在表单中添加类似的内容

<f:form.hidden name="receiverData[orders][0][order_id]" value="1234" />
<f:form.hidden name="receiverData[orders][0][product_id]" value="5678" />
<f:form.hidden name="receiverData[orders][0][product]" value="Produktname" />
<f:form.hidden name="receiverData[orders][0][quantity]" value="1337" />
<f:form.hidden name="receiverData[orders][0][price]" value="19.95" />
<f:form.hidden name="receiverData[orders][0][currency]" value="EUR" />

通过 Views.yaml 配置视图

如果您想覆盖您的网站包中的包模板，您可以在配置文件夹中创建一个 Views.yaml 文件。

-
  requestFilter: 'isPackage("KaufmannDigital.CleverReach") && isController("Subscription") && isAction("index")'
  options:
    templatePathAndFilename: 'resource://My.Package/Private/Templates/.../Index.html'
-
  requestFilter: 'isPackage("KaufmannDigital.CleverReach") && isController("Subscription") && isAction("subscribe")'
  options:
    templatePathAndFilename: 'resource://My.Package/Private/Templates/.../Subscribe.html'

常见问题解答

我遇到了错误 CleverReach 认证失败。凭证正确吗？
- 请确保您在 Settings.yaml 中配置的凭证是正确的。为了确认，请复制凭证并尝试使用它登录 CleverReach 网站。

已知问题

已知问题以问题报告的形式提交。请在提交您发现的问题之前查看它。
您修复了一个问题？太好了！请将其作为 PR 提交以与其他用户共享。

计划功能

计划的功能也作为问题创建，并标记为此类。
您还有其他想法吗？或者想帮助实现？我们很高兴！只需创建新的问题或 PR 即可。

维护者

此包由 Kaufmann Digital 维护。
请随时发送您的问题或请求至 support@kaufmann.digital

许可证

许可协议为 GPLv3+，请参阅 LICENSE

kaufmanndigital / cleverreach

维护者

详细信息