SugarCRMのSOAP操作について

フリーの顧客関係管理(CRM:Customer Relation Management)であるSugarCRMのデータを外部から操作する方法として、SOAP(Simple Object Access Protocol)という方法があります。
SOAPというのは、簡単に言えばHTTP上でXMLを使って、サーバ同士がデータをやりとりする方法の事です。
実際にはライブラリを使うので、SOAPの文法は知らなくても使えます。

ファイルのインポート・エクスポートに比べて、リアルタイムで自動化できる点がメリットです。
ただしPHPなどでコーディングしないといけません。以下がサンプルソース

&lt;?php
    $url = &quot;http://www.sample.com/sugarcrm/soap.php?wsdl&quot;;
    $username = &quot;admin&quot;;
    $password = &quot;admin&quot;;

    //SOAPのライブラリファイルをダウンロードしてインクルード
    require_once(&quot;./lib/nusoap.php&quot;);

    //WSDLで通信オブジェクトを生成
    $client = new nusoap_client($url, 'wsdl');

    //エラーがあったら表示して終了
    $err = $client-&gt;getError();
    if ($err)
    {
        echo '&lt;h2&gt;Constructor error&lt;/h2&gt;&lt;pre&gt;' . $err . '&lt;/pre&gt;';
        echo '&lt;h2&gt;Debug&lt;/h2&gt;&lt;pre&gt;' . htmlspecialchars($client-&gt;getDebug(), ENT_QUOTES) . '&lt;/pre&gt;';
        exit();
    }

    //ログイン配列を生成
    $login_parameters = array(
         'user_auth' =&gt; array(
              'user_name' =&gt; $username,
              'password' =&gt; md5($password),
              'version' =&gt; '1'
         ),
         'application_name' =&gt; 'SoapTest',
         'name_value_list' =&gt; array(
         ),
    );

	//ログイン
    $login_result = $client-&gt;call('login', $login_parameters);

	//ログイン結果を表示
    echo '&lt;pre&gt;';
    print_r($login_result);
    echo '&lt;/pre&gt;';

    //ログイン成功ならセッションIDが返ってくるので、それを使ってDB操作
    $session_id =  $login_result['id'];
    
 
	//テーブル名や検索条件を指定して、レコード検索
	$search_array = array(
	  'session' =&gt; $session_id,
	  'module_name' =&gt; 'Meetings',
	  'query' =&gt; 'date(meetings.date_end) = \'2012-12-31\'',
	  'order_by' =&gt; 'meetings.name',
	  'offset' =&gt; 0,
	  'select_fields' =&gt; array('status', 'date_end'),
	  'max_results' =&gt; 10,
	  'deleted' =&gt; 0
	);
	
	//検索結果を表示
	$search_result = $client-&gt;call('get_entry_list', $search_array);
	echo &quot;search_result=&quot;;
	print_r($search_result);


	//条件を指定して、UPDATE操作
	$new_values = array();
	foreach ($search_result['entry_list'] as $meeting) {
	  $new_value = array(
	    array('name'=&gt;'id', 'value'=&gt;$meeting['id']),
	    array('name'=&gt;'status', 'value'=&gt;'Held')
	  );
	  $new_values[]=$new_value;
	}
	$update_array = array(
	  'session' =&gt; $session_id,
	  'module_name' =&gt; 'Meetings',
	  'name_value_lists' =&gt; $new_values 
	);
	//UPDATE結果を表示
	$result = $client-&gt;call('set_entries', $update_array);
	echo &quot;update_result=&quot;;
	print_r($result);

	//最後にちゃんとログアウト操作をする
	$result = $client-&gt;call('logout', array('session'=&gt;$session_id));
	
	//ログアウト結果を表示
	echo &quot;logout_result=&quot;;
	print_r($result);
?&gt;

<?php

$url = "http://www.sample.com/sugarcrm/soap.php?wsdl";

$username = "admin";

$password = "admin";

//SOAPのライブラリファイルをダウンロードしてインクルード

require_once("./lib/nusoap.php");

//WSDLで通信オブジェクトを生成

$client = new nusoap_client($url, 'wsdl');

//エラーがあったら表示して終了

$err = $client->getError();

if ($err)

{

echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';

echo '<h2>Debug</h2><pre>' . htmlspecialchars($client->getDebug(), ENT_QUOTES) . '</pre>';

exit();

}

//ログイン配列を生成

$login_parameters = array(

'user_auth' => array(

'user_name' => $username,

'password' => md5($password),

'version' => '1'

'application_name' => 'SoapTest',

'name_value_list' => array(

);

//ログイン

$login_result = $client->call('login', $login_parameters);

//ログイン結果を表示

echo '<pre>';

print_r($login_result);

echo '</pre>';

//ログイン成功ならセッションIDが返ってくるので、それを使ってDB操作

$session_id = $login_result['id'];

//テーブル名や検索条件を指定して、レコード検索

$search_array = array(

'session' => $session_id,

'module_name' => 'Meetings',

'query' => 'date(meetings.date_end) = \'2012-12-31\'',

'order_by' => 'meetings.name',

'offset' => 0,

'select_fields' => array('status', 'date_end'),

'max_results' => 10,

'deleted' => 0

);

//検索結果を表示

$search_result = $client->call('get_entry_list', $search_array);

echo "search_result=";

print_r($search_result);

//条件を指定して、UPDATE操作

$new_values = array();

foreach ($search_result['entry_list'] as $meeting) {

$new_value = array(

array('name'=>'id', 'value'=>$meeting['id']),

array('name'=>'status', 'value'=>'Held')

);

$new_values[]=$new_value;

}

$update_array = array(

'session' => $session_id,

'module_name' => 'Meetings',

'name_value_lists' => $new_values

);

//UPDATE結果を表示

$result = $client->call('set_entries', $update_array);

echo "update_result=";

print_r($result);

//最後にちゃんとログアウト操作をする

$result = $client->call('logout', array('session'=>$session_id));

//ログアウト結果を表示

echo "logout_result=";

print_r($result);

関連記事