README

此存储库包含一个用于添加API到Magento的源代码，该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

要从basic指标组获取所有数据，请使用以下方法

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

完成。

yireo / magento1-mpi

维护者

详细信息