findologic/plentymarkets-rest-exporter-new

FINDOLOGIC产品数据导出器,通过plentymarkets REST API导出


README

GitHub Actions Tests codecov

目录

  1. 摘要
  2. 需求
  3. 安装
  4. 运行导出
  5. 开发
    1. 运行导出
      1. 使用shopkey运行导出
      2. 配置
      3. 调试导出

摘要

这是对findologic/plentymarkets-rest-export的重写,目前仍在进行中。

Plentymarkets REST API被调用以获取FINDOLOGIC所需的所有产品数据。然后,数据被包装成FINDOLOGIC可消费的XML/CSV文件。如果是XML,可能是多个文件。

需求

  • PHP >= 7.4
  • PHP JSON扩展
  • Composer

安装

  1. 运行 composer install 安装所有必需的依赖。
  2. .env 复制到 .env.local,并设置要从其中导出数据的商店的配置。

运行导出

  1. 运行 bin/console export:start
  2. 如果导出成功,您可能可以在 /export 目录中找到导出的CSV/XML文件。
  • 如果您有shopkey,请参阅使用shopkey运行导出
  • 如果调试模式为true,您可能可以在 /var/debug 目录中找到所有请求/响应。

如果您想进行调试,请参阅调试导出的相关内容。

开发

目录结构

  • .github 包含与GitHub相关的所有内容,包括GitHub Actions。
  • bin 包含可执行文件。例如 运行导出
  • config 包含配置文件。例如 导出配置
  • var/debug 包含启动导出后的请求/响应。
  • var/export 包含导出的XML(CSV)文件。
  • var/log 包含上次导出的日志。
  • src 包含所有源代码。
  • tests 包含所有单元测试。
  • vendor 包含依赖项的源代码。

运行测试

运行测试非常简单。您可以选择运行 composer test,或者使用您的IDE运行测试。使用IDE运行测试时,您可能希望包括 phpunit.xml.dist 作为替代配置文件。

使用shopkey运行导出

注意:使用shopkey运行导出需要将环境文件中的 IMPORT_DATA_URL 选项设置。

您还可以通过调用具有额外shopkey参数的导出或 bin/console export:start [shopkey] 来为特定shopkey运行导出。

如果提供了shopkey,可能会忽略 EXPORT_xxx 环境变量。

配置

以下是一个简短的表格,解释了每个配置选项。可以在环境文件中执行配置更改。

调试导出

如果您要调试导出,可以右键单击IDE中的 bin/console 并选择 "调试 'export (PHP Script)'"。

将环境变量 "DEBUG" 设置为 true,将自动在 var/debug 文件夹中创建请求/响应文件。
如果不再需要它们,可以在任何时候运行 composer clearbin/clearExportFiles 来清除它们。