Soap Interface.
Talk to external computer systems from your intranet.
A RPC (Remote Procedure Call) allows you to access some of the functions within the Claromentis framework via external systems.
Starting from Claromentis 6.0 we provide a SOAP-based web service to access some of our core functions. As the service uses the same web server as the main Claromentis installation, it doesn't require any additional configuration.
For more information we recommend this Wikipedia SOAP article.
Other code examples within Claromentis - Implementing an RPC Adapter.
Web Service.
The main entry point to all SOAP functions in Claromentis is http://host.name/intranet/rpc/soap.php. But as different applications inside Claromentis use different WSDL (Web Service Description) file, this PHP script requires additional parameters:
- WSDL file for application "core": http://host.name/intranet/rpc/soap.php?core:wsdl
- WSDL file for application "users": http://host.name/intranet/rpc/soap.php?users:wsdl
- WSDL file for application "docs": http://host.name/intranet/rpc/soap.php?docs:wsdl
The actual service URL is defined in the WSDL file, but the service can normally be found at http://host.name/intranet/rpc/soap.php?app_code
Web service usage example.
Please note that while the example below is PHP any programming language can be used.
<?php
$cla_core = new SoapClient("http://host.name/intranet/rpc/soap.php?core:wsdl");
var_export($cla_core->__getFunctions()); // shows list of supported functions
$auth_result = $cla_core->Login("username", "password");
if (!$auth_result->user_id)
echo "Error: ".$auth_result->error."\n";
else
echo "Logged in successfully. User id = ".$auth_result->user_id."\n";
$cla_users = new SoapClient("http://host.name/intranet/rpc/soap.php?users:wsdl");
$uinfo_result = $cla_users->GetUserInfo($auth_result->auth_key, $auth_result->user_id);
var_export($uinfo_result); // shows information about current user
$cla_core->Logout($auth_result->auth_key);
?>
1