zaius/zaius-magento-2

为 Magento 2 优化的 Zaius Engage 连接器。

维护者

详细信息

github.com/ZaiusInc/zaius-magento-2

源代码

问题

安装量: 36,032

依赖项: 0

建议者: 0

安全性: 0

星标: 3

关注者: 12

分支: 6

开放问题: 8

类型:magento2-module

1.0.8 2024-07-19 19:44 UTC

Requires

MIT 46f72aa4ff07d44e66f6659ede2c56c2e61b6fed

This package is auto-updated.

Last update: 2024-09-19 20:05:09 UTC

README

使用 Zaius Magento 2 连接器将 Zaius 直接集成到您的 Magento 实例中。

入门

以下说明将帮助您将项目复制到本地机器，以便进行开发和测试。有关如何在实时系统上部署项目的说明，请参阅部署部分。

先决条件

  1. Magento 2 "^2.2.5"
  2. PHP 5 >= 5.5.0，PHP 7
  3. Composer

安装

Composer

安装和维护 Zaius 连接器最快、最简单的方法是使用 Composer。

  1. 需要 Zaius Magento 2 包。
  2. 安装 Zaius Magento 2 包。
  3. 最后，确保包是最新的。

关于已安装先前 RC 版本的用户注意事项

现在已有稳定版本可用，您可以从您的 <MAGENTO_ROOT>/composer.json 文件中 移除 这些先前所需的行

"minimum-stability" "RC",
"prefer-stable": true

  • 添加所需的包。
composer require zaius/zaius-magento-2
composer install
composer update zaius/*

替代安装：ZIP

需要 Zaius PHP SDK，如果您选择通过 ZIP 存档安装，则需要单独安装。

  • 添加所需的包
composer require zaius/zaius-php-sdk:^1.0
composer install
composer update zaius/*

验证并启用 Zaius Magento 2 连接器

  • 为了验证扩展是否正确安装，请运行以下命令
php bin/magento module:status

默认情况下，扩展可能未启用，您将看到如下输出

List of disabled modules:
Zaius_Engage
  • 启用扩展并清除静态视图文件
php bin/magento module:enable Zaius_Engage --clear-static-content

您应该看到以下输出

The following modules have been enabled:
- Zaius_Engage

To make sure that the enabled modules are properly registered, run 'setup:upgrade'.
Cache cleared successfully.
Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes.
Generated static view files cleared successfully.
  • 注册扩展
php bin/magento setup:upgrade
  • 重新编译您的 Magento 项目
php bin/magento setup:di:compile
  • 验证扩展是否启用
php bin/magento module:status

您应该看到输出，验证扩展不再被禁用

List of enabled modules:
Zaius_Engage

List of disabled modules:
None
  • 清除缓存
php bin/magento cache:clean

API 设置

为了支持 Zaius 使用的优惠券代码功能，并使 Zaius 支持团队能够最有效地解决任何问题，我们需要创建一个具有访问 Zaius API 权限的 API 用户。

创建适当的角色

在 Magento 管理面板中，转到系统 > 用户角色（在“权限”标题下）。

  1. 点击“添加新角色”。
  2. 输入名称“Zaius API”。
  3. 点击“角色资源”。
  4. 选择“Zaius Engage API”资源。
  5. 点击“保存角色”。

创建 API 用户

仍在 Magento 管理面板中，转到系统 > 所有用户（在“权限”标题下）。

  1. 点击“添加新用户”。
  2. 输入用户名“zaius_api”。
  3. 输入您喜欢的详细信息（Zaius 建议输入维护者的详细信息）作为姓名和电子邮件。
  4. 为用户创建新密码（并确保将其保存在安全的密码管理器或类似密钥存储中）。
  5. 点击“用户角色”。
  6. 选择您在上一部分中创建的“Zaius API”角色。
  7. 点击“保存用户”。

在 Zaius 中保存 API 用户

转到 Zaius 集成页面 (设置（齿轮）> 集成)，确保您正在编辑此 Magento 店铺将与之集成的 Zaius 帐户（测试或生产，适用于相关品牌）。

  1. 点击“Magento”卡片。
  2. 从版本下拉菜单中选择“Magento 2”。
  3. 将用户名输入为“zaius_api”。
  4. 输入上一部分中配置的密码。
  5. 请输入基础Magento API URL，通常与您的网站根URL相匹配。
  6. 点击保存。

Zaius不建议此时点击“开始批量导入”。请咨询您的客户成功经理协调批量导入流程。

配置

安装模块并设置API用户后，所有配置都通过“商店”>>“配置”>>“Zaius”>>“Engage”完成。

Zaius Engage状态

启用：启用或禁用Zaius Engage连接器功能。

版本：当前安装的Zaius Engage连接器版本。

Composer已安装？：检查Composer是否已安装。对于Magento 2项目，将始终安装。

SDK已安装？：检查Zaius PHP SDK是否已安装。SDK是Zaius Engage连接器所必需的，并会与Composer自动安装。

Zaius Tracker ID：Zaius客户端Tracker ID的配置字段。在Zaius客户端账户的API管理中找到。

Zaius私有API密钥：Zaius私有API密钥的配置字段。在Zaius客户端账户的API管理中找到。这是[批量更新](批量更新)正常工作所必需的。

Amazon S3

启用Amazon S3：启用或禁用Amazon S3上传功能。

Amazon S3密钥：Zaius客户端Amazon S3密钥的配置字段。在Zaius客户端账户的集成中找到。如果启用了Amazon S3功能，这是必需的。

Amazon S3密钥：Zaius客户端Amazon S3密钥的配置字段。在Zaius客户端账户的集成中找到。如果启用了Amazon S3功能，这是必需的。

设置

全局ID前缀：如果提供，则此前缀将被添加到从相应商店视图发送的所有产品、客户和订单ID。这很少需要，但在复杂的多店配置中可能有所帮助。通常，如果您的设置将从中受益，您的Zaius CSM会建议您使用此功能。

Zaius新闻通讯列表ID：当最终用户订阅或取消订阅此商店视图中的Magento新闻通讯时，订阅将与Zaius中提供的列表同步。

收集所有产品属性：启用或禁用收集默认属性集中定义的所有产品属性的功能，或仅收集Zaius精选的最小值。如果您的产品数据流中存在Zaius尚未捕获的字段，您可能需要启用此功能，确保该字段已添加到默认属性集，并在Zaius中创建相应的自定义字段。有关更多详细信息，请参阅"收集其他产品属性"

超时：指定在超时连接到Zaius之前的秒数。

模式更新

更新模式：当点击此按钮时，Magento将使用提供的API密钥（在Zaius Engage状态部分中）评估Zaius中的对象和字段，并将创建为Magento集成核心功能所需的所有字段。

Zaius本地化

启用？：启用或禁用Zaius本地化功能。启用Zaius本地化功能后，本地化store_view数据将发送到Zaius。启用之前，请咨询您的Zaius CSM。

收集额外的产品属性

“收集所有产品属性”功能仅限于收集“默认”属性集中的所有属性。此属性集是用户可配置的，因此可以包含自定义属性，但如果您使用多个不同的属性集，并且一些产品仍然使用默认属性集，您可能会遇到限制。具体来说，如果自定义属性是必填字段，但仅适用于使用特定属性集的产品，将此属性添加到默认属性集会导致没有自己的属性集的产品需要不相关的字段。

如果属性是必填的且无法添加到默认属性集，则可以导出缺失的属性，并将其作为单独的CSV文件上传。

如果“默认”属性集未应用于任何产品，或所需属性是必填值，只需将缺失的属性添加到默认属性集并启用“收集所有产品属性”。

调整默认属性集

要将属性添加到默认属性集，用户需要登录到Magento管理界面。从这里，他们应该

  1. 导航到商店 > （属性部分）属性集
  2. 单击“默认”集（如果需要，可以使用搜索栏找到它）
  3. （推荐，但不强制）：在中间的“组”部分，单击“添加新”并创建一个名为“Zaius字段导入”的新组。这将允许您在目录中分组属性，并将标题分开，不会展开也不会干扰。
  4. 在右侧的“未分配属性”部分，单击并拖动任何缺失的属性到中间的“组”部分。如果您执行了步骤3，将缺失的属性添加到“Zaius字段导入”组；否则，放在您认为合适的位置。
  5. 单击保存。以下步骤不是严格必需的，但在某些环境中似乎刷新了连接器的产品数据视图
  6. 导航到商店 > （属性部分）产品
  7. 找到并单击任何一个之前缺失的属性。
  8. 单击“保存属性”按钮（您不需要做出任何更改）。

最后，请Zaius支持重新导入您的产品数据，以确保所有现有产品的新字段都已填充。

版本控制

我们使用SemVer进行版本控制。有关可用的版本，请参阅此存储库上的标签。

发布说明

1.0.4 - 2019-11-27: 稳定性修复

  • 将基本版本恢复到1.0.0
  • 重新应用“可配置产品现在报告其自己的产品ID作为其parent_product_id（在Zaius中更平滑地使用parent_product字段）。”
  • 重新应用“用户报告了当购物车中有多个项目且其中一个项目被更新时的不正确引用。此问题已解决。”
  • 修复了由Zaius SDK未加载引起的边缘情况：添加到购物车和其他购物车更新不再因Zaius cookie未定义而面临错误风险
  • 增加了更好的服务器端错误处理

1.0.3 不稳定 - 2019-11-22 热修复：尊重跟踪ID

  • 由于发布后发现的问题，此版本不应安装。

1.0.2 不稳定 - 2019-11-21 热修复：删除对SDK的结账依赖性

  • 由于发布后发现的问题，此版本不应安装。

1.0.1 不稳定 - 2019-11-19 修复：父产品和迷你购物车

  • 由于发布后发现的问题，此版本不应安装。
  • 可配置产品现在报告其自己的产品ID作为其parent_product_id（在Zaius中更平滑地使用parent_product字段）。
  • 用户报告了当购物车中有多个项目且其中一个项目被更新时的不正确引用。此问题已解决。

1.0.0 - 2019-07-23 - 首次发布

许可

本项目遵循MIT许可协议 - 详细信息请参阅许可文件。