README

此存储库包含用于添加 API 到 Magento 的 Magento 1 扩展源代码，该 API 由 Yireo 开发的 Magento 性能洞察 (MPI) 服务使用。 https://www.yireo.com/services/magento-services/magento-performance-insights

关于 Magento 性能洞察服务

Yireo MPI 服务允许您快速收集来自您的 Magento 商店及其托管环境的众多指标。拥有活跃的 MPI 订阅后，这些数据将被收集并存储在私有的 Yireo 服务器上。接下来，数据将被解释并以可视化方式展示在 Yireo 网站上。最后，您将获得针对您环境的性能设置概览，以及如何优化到极致的个性化建议。

身份验证

只有在 URL 调用中添加特定密钥时，才允许访问 API。密钥长度必须为 10 个字符或更多，可在 Magento 的 系统配置 中的 Yireo MPI 部分进行配置。密钥设置后，需要将附加的密钥添加到 URL，如下所示

http://MAGENTO/mpi/index/index/secret/SECRET

访问 API

访问此 MPI 扩展 API 有两种方式。第一种方法是调用以 mpi 开头的模块 URL - 这是 MVC 方法。第二种方法是调用 yireo_mpi.php 文件 - 这是入口文件方法。

MVC 方法

可以通过以下方式访问 IndexController 的 index 操作

http://MAGENTO/mpi/index/index/secret/SECRET

这会列出所有可用的指标组和它们的指标。

要获取 "基本" 指标组的所有数据，使用以下方法

http://MAGENTO/mpi/index/collect/group/basic/secret/SECRET

要获取 "测试" 指标的所有数据，使用以下方法

http://MAGENTO/mpi/index/collect/metric/test/secret/SECRET

请注意，一个指标可能仍然包含多个结果。

API 只处理基本的 GET 和 POST 请求，不处理复杂的 REST 或 JSON-RPC。

入口文件方法

可以通过以下方式访问入口文件

http://MAGENTO/yireo_mpi.php

要获取 "基本" 指标组的所有数据，使用以下方法

http://MAGENTO/yireo_mpi.php?action=collect&group=basic&secret=SECRET

您可以使用 all 组来获取所有资源。

格式

默认情况下，输出为 JSON 格式。您可以通过更改 URL 中的 format 参数切换到简单的 PHP 输出。

http://MAGENTO/mpi/index/index/format/json
http://MAGENTO/mpi/index/index/format/dump

使用 composer 的说明

使用 composer 安装此扩展。首先确保使用正确的设置初始化 composer

composer -n init
composer install --no-dev

然后，修改您的本地 composer.json 文件

{
    "require": {
        "yireo/magento1-mpi": "dev-master",
        "magento-hackathon/magento-composer-installer": "*"
    },    
    "repositories":[
        {
            "packagist": false
        },
        {
            "type":"composer",
            "url":"https://packages.firegento.com"
        },
        {
            "type":"composer",
            "url":"https://satis.yireo.com"
        }
    ],
    "extra":{
        "magento-root-dir":"/path/to/magento",
        "magento-deploystrategy":"copy"           
    }
}

请确保正确设置 magento-root-dir。通过运行以下命令进行测试：

composer update --no-dev

完成。