Magento web services API 扩展

<?xml version="1.0"?>
<config>
    <modules>

        <Example_Webservices>
            <active>true</active>
            <codePool>local</codePool>
        </Example_Webservices>
    </modules>
</config>

 Magento提供了一个便捷的API来于其他类型的系统进行整合，而且这些API也可以在用户需要的时候做相应的扩展来完成一些默认的API没有提供的功能。但是错误的override Magento核心代码将给系统升级带来兼容性问题。下面的是一个能避免与Magento将来版本出现不兼容问题的例子。

首先，我们先对Magento的API进行定位，在app/code/core/Mage/Sales/Model/Order/Api.php中对API进行了定义。举个例子：我们需要根据客户的ID来查看客户订单(系统默认只提供了通过increment IDs来查看,例如 "#100000003",其实就是订单号)。通过我们的研究，发现Api.php中的_initOrder()方法：

 

 protected function _initOrder($orderIncrementId)
    {
        $order = Mage::getModel('sales/order');
 
        /* @var $order Mage_Sales_Model_Order */
 
        $order->loadByIncrementId($orderIncrementId);
 
        if (!$order->getId()) {
            $this->_fault('not_exists');
        }
 
        return $order;
    }

 

  

要完成我们的所需的扩展需要override这个方法，我们可以copy该Api.php到app/code/local(当然保持相似的目录结构), 但是我们只需要修改一个方法，所以只需要override该方法即可(这就是Magento的灵活之处)。
Create Example_Webservices.xml in app/etc/modules，内容如下：

 

Create the directory app/code/local/Example/Webservices/etc, and create config.xml containing:

<?xml version="1.0"?>
<config>
    <global>
        <models>
            <sales>
                <rewrite>
                    <order_api>Example_Webservices_Model_Sales_Order_Api</order_api>
                </rewrite>
            </sales>
        </models>
    </global>
</config>

 

上面的代码是我们overriding一个module时的基本形式。这样子我们已经把到Mage_Sales_Model_Order_Api的所有请求rewrite到Example_Webservices_Model_Sales_Order_Api。

最后，我们建立自己的model来override所有我们想要override的方法.
Create app/code/local/Example/Webservices/Model/Sales/Order/Api.php containing:

class Example_Webservices_Model_Sales_Order_Api extends Mage_Sales_Model_Order_Api
{
    protected function _initOrder($orderIncrementId)
    {
        $order = Mage::getModel('sales/order');
 
        if(is_string($orderIncrementId)) {
            $order->loadByIncrementId($orderIncrementId);
            if (!$order->getId()) {
                $this->_fault('not_exists');
            }
        } else {
            $order->load($orderIncrementId);
            if (!$order->getId()) {
                $this->_fault('not_exists');
            }
        }
        return $order;
    }
}

 

通过上面的方法，以最少的改动来满足我们的要求同时有不影响系统的更新。

(This class overrides the original model class we're overriding - this way, we only change the specific methods we want to change and minimise the chance of interfering with an upgrade. The modifications to the body of the method are quite simple. Instead of always loading by increment ID, we first check if the $orderIncrementId parameter we are passed is a string. If it's a string, we do an increment ID lookup; if not, we assume it's an ID and look up on that. This works in a similar way to products, where you can use the API to get a product by either ID or SKU.

If your Magento store needs to work with another application in a way that Magento doesn't support, this simple example shows how easy it is to extend Magento's web services API's to allow you to achieve the integration that you require.)