Magento – How to add parameter with SOAP request

apimagento-1.9php-5.2.x.xsoap

I'm new to Magento I try to call category level using Magento SOAP API with parent category id. I use following code.

<?php
$proxy = new SoapClient('http://domain/index.php/api/soap/?wsdl');
$session = $proxy->login('user', 'password');
$result = $proxy->call($session,'catalog_category.level');
echo json_encode($result);
?>

Here for the above code, "Default Category" details are coming. now I try to call some other category by using following codes.

$result = $proxy->call($session,'catalog_category.level',12);

That is not working

$arguments = array( 'parentCategory' => 12);
$result = $proxy->call($session,'catalog_category.level',$arguments);

This is also not working.

Then I try to call category tree using following code.

 <?php
$proxy = new SoapClient('http://domain/index.php/api/soap/?wsdl');
$session = $proxy->login('user', 'password');
$result = $proxy->call($session,'catalog_category.tree');
echo json_encode($result);
?>

it showing all the category tree. it means API is working but whenever I try to pass an argument it showing server not found an error.

Can any one please tell me how to pass arguments with the request.

Best Answer

<?php
/* code to check SOAP enabled in your server or not */
echo (extension_loaded('soap'))?'SOAP Enabled':'SOAP Disabled';echo '<br />';
echo (class_exists('SOAPClient'))?'SOAP Client Present':'SOAP Client Absent';echo '<br />';
echo (class_exists('SOAPServer'))?'SOAP Server Present':'SOAP Server Absent';echo '<br />';



/** Code to authenticate SOAP credentials and authorize the request URL **/
$apiUrl = 'http://localhost/magento/index.php/api/soap/?wsdl';
$apiUser = 'yourSoapApiUser'; 
$apiKey = 'yourSoapApiKey';

ini_set("soap.wsdl_cache_enabled", "0");
try{
    $client = new SoapClient($apiUrl, array('cache_wsdl' => WSDL_CACHE_NONE));
} catch (SoapFault  $e) {
    echo 'Error in Soap Connection : '.$e->getMessage();
}
try {
    $session = $client->login($apiUser, $apiKey);
    if($session){
        $params = array('storeId'=>$storeId,'categoryId'=>$categoryId);
        try {
            $result = $client->call($session, 'catalog_category.tree',$params);
            echo json_encode($result);
        } catch(Exception $e) {
            $result = json_encode(array('isFault' => 1, 'faultMessage'=>$e->getMessage()));
            $error = true;
        }
    }else echo 'SOAP Connection Failed.';
} catch (SoapFault  $e) {
    echo 'Wrong Soap credentials : '.$e->getMessage();
}

The above code worked fine for me. If it won't for you then check your corresponding Api.php method.

Gist : Multiple request params are always sent in an array.

Related Solutions

Magento – Fetch catalogCategoryTree through Soap API fails with custom attribute

The tree method returns objects of type catalogCategoryTree that looks like this:

<complexType name="catalogCategoryTree">
    <all>
        <element name="category_id" type="xsd:int"/>
        <element name="parent_id" type="xsd:int"/>
        <element name="name" type="xsd:string"/>
        <element name="position" type="xsd:int"/>
        <element name="level" type="xsd:int"/>
        <element name="children" type="typens:ArrayOfCatalogCategoryEntities"/>
    </all>
</complexType>

This one does not contain the field legacy_id. You can extend the api and add it. Here are some pointers on who to extend the wsdl.

Also take a look at the tree method in the category API, specially the last lines:

$collection = Mage::getModel('catalog/category')->getCollection()
            ->setStoreId($this->_getStoreId($store))
            ->addAttributeToSelect('name')
            ->addAttributeToSelect('is_active');

$tree->addCollectionData($collection, true);
return $this->_nodeToArray($root);

Your attribute is not added to the collection. So you can override this method to add it.
Also the returned value is processed by the method _nodeToArray() that looks like this:

protected function _nodeToArray(Varien_Data_Tree_Node $node)
{
    // Only basic category data
    $result = array();
    $result['category_id'] = $node->getId();
    $result['parent_id']   = $node->getParentId();
    $result['name']        = $node->getName();
    $result['is_active']   = $node->getIsActive();
    $result['position']    = $node->getPosition();
    $result['level']       = $node->getLevel();
    $result['children']    = array();

    foreach ($node->getChildren() as $child) {
        $result['children'][] = $this->_nodeToArray($child);
    }

    return $result;
}

You may need to override this also to include your attribute value in the result array.

Magento SOAP V1 – Change SOAP Address in Magento Enterprise

Try and set the store url in admin as {{base_url}} (this must be changed before you go live). Using that magento will use whatever domain as used to call the site.

Update, after OP comments:

If you trace the code on how the WSDL gets built, you will find the wsdl.xml file in app/code/core/Mage/Api/etc/wsdl.xml

at the end of that file:

<service name="{{var wsdl.name}}Service">
        <port name="{{var wsdl.handler}}Port" binding="typens:{{var wsdl.handler}}Binding">
            <soap:address location="{{var wsdl.url}}" />
        </port>
    </service>

thus magento populates the url in the file from a var called wsdl.url.

Searching the code for where that gets populated reveals:

Mage_Api_Model_Server_Adapter_Soap::run

$wsdlConfig->setUrl(
                htmlspecialchars(Mage::getUrl('*/*/*', array('_query'=>$queryParams) ))
            );

Thus the url is generated using standard magento getUrl method, thus reading it from your config.

So it is very likely that you changed the wrong one. Did you change the default base url, or the site base url? Try the other, or both.

Alternatively, you can copy the wsdl.xml to your local folder, and temporarily override it and hard-code the address. This is a really bad hack, and should try not to do it, but should help you get your testing done ;) It is most likely that you'd need to do this elsewhere, so I would do that as a last resort only.

Best Answer

Related Solutions

Magento – Fetch catalogCategoryTree through Soap API fails with custom attribute

Magento SOAP V1 – Change SOAP Address in Magento Enterprise

Related Topic