Joomla SOAP Integration

Instructions

The Joomla SOAP Integration extension integrates the NuSOAP library and makes it easy to write your own custom functions and making them available through a SOAP service with WSDL support. You create a Joomla SOAP plugin which contains your custom functionality.
From the admin component you create a web service and select which of the installed and enabled SOAP Plugins should be included, thus making up the functions for the web service. You can also select an authentication method.

Creating a SOAP Plugin

To create your custom functions for the SOAP web service, you have to create a Joomla Plugin of type SOAP. In this plugin you can have as many functions as you wish, but you need to register the specific functions for the web service to make them callable by SOAP clients.
Download the Hello World example plugin and see how you can create your own plugin. If you install this plugin it will also create a sample web service!

Complex Types Support

You can also add your own complex types to your webservice within the same plugin. Download the Hello Complex World SOAP plugin and see how you can add your own complex types.

Creating a SOAP web service

When the SOAP plugins are installed and enabled you are ready to create your web service. Go to the SOAP Integration component and from the Control Panel, click Web Services and then New. Enter a Title to identify your web service in Joomla. Enter a namespace for your functions. The namespace is a name for your web service functions and is not an URL for the SOAP envelope.
From the parameters you select which of the installed SOAP Plugins should be part of your web service. If none are selected, by default all the registered functions from all the enabled SOAP Plugins are added.

Select an authentication method:
- You can select to have no authentication. This makes your webservice publicly available, so be careful.
- You can select to enter a username and password.
- You can select to use a specific Joomla user. Only the username and password for this user is accepted.
- You can select an access level. The usernames and passwords of the Joomla users with access to the selected level will be accepted.

Now click save and your web service is up and running. From the web services overview you see the URL to your web service. If you go to this URL you can see the available functions for this web service. Also the link to the WSDL.

Version log:

08-04-2013: 0.4.4: Added a feature to set the envelope encoding to UTF-8

23-11-2012: v 0.4.0 Added a param to set the style of the webservice to RPC/Encoded (default) or Document/Literal

25-09-2012: v 0.3.0 Now added support for Complex Types with thanks to DJ Consultancy

31-07-2012: Release

Disclaimer:

The SOAP Integration extension is not affiliated with or endorsed by the Joomla! Project. It is not supported or warranted by the Joomla! Project or Open Source Matters. The Joomla! logo is used under a limited license granted by Open Source Matters the trademark holder in the United States and other countries.