reiterus/informer-magento

从 REST API 端点获取 Magento 2 商店信息

安装: 2

依赖: 0

建议者: 0

安全: 0

星标: 2

关注者: 1

分支: 0

公开问题: 0

类型:magento2-module

1.2.0 2022-07-16 11:57 UTC

This package is auto-updated.

Last update: 2024-09-16 18:33:16 UTC


README

使用 GET 请求到 REST API 端点获取您的 Magento 2 商店信息。

此模块是为 Magento 版本 2.4.3 开发的

用法

端点

  • 基本信息: /rest/V1/reiterus/informer
  • 详细信息: /rest/V1/reiterus/informer/detail

响应

匿名用户的基本信息

{
    "version": "2.4.3",
    "locale": "en_US",
    "timezone": "America\/Chicago",
    "currency": "USD"
}

详细信息的列表由您自行决定,可能如下所示。

[
    {
        "lifetime_sales": "29.00",
        "average_order": "14.50",
        "orders_number": "2",
        "customers_number": "1",
        "admins_number": "3",
        "extended_data": "from main application"
    }
]

设置详细信息

要生成详细信息的扩展数据集,您可以使用“示例”目录中的插件。不要忘记在您的 di.xml 文件中包含以下信息。

<type name="Reiterus\Informer\Model\Informer">
    <plugin name="reiterus_fill_detail_info"
            type="Vendor\Module\Plugin\InformerBefore" />
</type>

端点测试

要检查端点功能,您可以使用请求目录中的文件通过 PhpStorm。

  • base.http:获取最小基础信息
  • detail.http:获取您需要的详细信息
  • token.http:获取管理员令牌

更多信息请参阅“请求”文件夹。

安装

您可以通过两种方式安装此包

从 packagist.org

composer require reiterus/informer-magento

从 GitHub 仓库

{
 "repositories": [
  {
   "type": "vcs",
   "url": "https://github.com/reiterus/informer-magento.git"
  }
 ]
}

许可证

此库是根据 MIT 许可证 发布的。