Connecting to Magento via SOAP

Fri, 12 Jul 2013 00:00:00 +0000

In my earlier post I have shown how you can connect to Magento with REST api. In this post let us connect via SOAP.

The below class acts like a proxy to call the magento soap api.

<?php
/**
 * 
 * @author Hari K T
 * 
 */
class My_Soap_Magento
{
    /**
     * 
     * Host name to connect
     * 
     * @var string
     * 
     */
    protected $hostname;

    /**
     * 
     * User name
     * 
     * @var string
     * 
     */
    protected $username;
    
    /**
     * 
     * API Key
     * 
     * @var string
     * 
     */
    protected $apikey;
    
    /**
     * 
     * Zend_Soap_Client
     * 
     * @var Zend_Soap_Client
     * 
     */
    protected $client;
    
    
    protected $session;
    
    /**
     * 
     * Constructor
     * 
     * @param string $hostname The host name
     * 
     * @param string $username The user name of the host
     * 
     * @param string $apikey The apikey of the host
     * 
     */
    public function __construct($hostname, $username, $apikey)
    {        
        $this->hostname = $hostname;
        $this->username = $username;
        $this->apikey   = $apikey;        
    }
    
    /**
     * 
     * Magic method, the methods are named on the basis of Magento SOAP api
     * You don't need to pass the session as the first argument, for convience.
     * 
     * @link http://www.magentocommerce.com/api/soap/introduction.html
     * 
     * @param string $function
     * 
     * @param mixed $args
     * 
     * @return string | null
     * 
     */
    public function __call($function, $args)
    {
        $session = $this->getSession();
        $params = array_merge(array($this->getSession()), $args);
        $result = call_user_func_array(array($this->getClient(), $function), $params);
        if ($result) {
            // I need to get as json
            return Zend_Json_Encoder::encode($result);
        }
        return null;
    }        
    
    /**
     * 
     * Get the session from logging in to the Magento server
     * 
     * @return string
     * 
     */
    public function getSession()
    {
        if (! $this->session) {
            try {
                $this->session = $this->getClient()->login($this->username, $this->apikey);
            } catch (Exception $e) {
                
            }
        }
        return $this->session; 
    }
    
    /**
     * 
     * If we already have a session, we can set the session so it don't 
     * need to login again and get the session. This helps to reduce the 
     * call for login . 
     * 
     * @see getSession()
     * 
     * @param string $session
     * 
     * @return IM_Soap_Magento
     * 
     */
    public function setSession($session)
    {
        $this->session = $session;
        return $this;
    }
    
    /**
     * 
     * Get the Zend_Soap_Client object
     * 
     * @return Zend_Soap_Client
     * 
     */
    public function getClient()
    {
        if (! $this->client) {
            $endpoint  = trim($this->hostname, '/') . '/api/v2_soap/?wsdl';
            $this->client = new Zend_Soap_Client(            
                $endpoint
            );
        }     
        return $this->client;   
    }
}

In order to connect you want to create an object of the above class My_Soap_Magento. You need to get the username and api key from the magento host.

Magento and the REST API

Fri, 05 Jul 2013 00:00:00 +0000

Magento provides both REST and SOAP api. In this post I would like to concentrate on REST api to connect and get the products from magento shop.

First we want to register an Oauth consumer to get the consumer key and secret key.

Login to the admin of the magento shop and from the menu System->Web Services->REST - Oauth Consumers and add a new Ouath consumer.

Magento on Hari KT — Full Stack Developer

Connecting to Magento via SOAP

Magento and the REST API