Difference between revisions of "webBooks APIs"
Digitalpipe (Talk | contribs) (Created page with "Below you will see a list of each official module produced by Cliquesoft. Clicking on a module name from the list will take you to the appropriate section that outlines the vari...") |
Digitalpipe (Talk | contribs) |
||
| Line 5: | Line 5: | ||
==System Configuration== | ==System Configuration== | ||
| + | |||
| + | ===Load the interface=== | ||
To load the modules default HTML interface (themes/default/webbooks.system_configuration.html), the below parameters should be passed. Loading an alternative screen relies on the symlinks set in the users data directory (e.g. data/_guest/_theme/{images|layout|styles}). | To load the modules default HTML interface (themes/default/webbooks.system_configuration.html), the below parameters should be passed. Loading an alternative screen relies on the symlinks set in the users data directory (e.g. data/_guest/_theme/{images|layout|styles}). | ||
<pre> | <pre> | ||
| Line 12: | Line 14: | ||
SID= | SID= | ||
</pre> | </pre> | ||
| + | |||
| + | This will return the raw contents as it is found in the file, replacing all occurrences of the variable ${UN} anywhere. | ||
| + | |||
| + | ===Populate the form=== | ||
| + | To populate all the various values of the interface form objects, the below parameters will need to be passed. | ||
| + | <pre> | ||
| + | action=init | ||
| + | target=values | ||
| + | username= | ||
| + | SID= | ||
| + | </pre> | ||
| + | |||
| + | This will return all the information in the following XML layout: | ||
| + | <pre> | ||
| + | <general> | ||
| + | <admin id="INTEGER" name="STRING" type="{provider|vendor|employee}" email="STRING" phone="INTEGER" ext="INTEGER" mobile="INTEGER" sms="{0|1}" mail="{0|1}" /> | ||
| + | <system socialURI="STRING" [accessURI="STRING" logins="INTEGER" support="STRING" balance="DECIMAL" prefix="STRING"] /> | ||
| + | </general> | ||
| + | </pre> | ||
| + | |||
| + | The <system> tag has only one mandatory value (socialURI) when the software is not working in a HOSTED mode, otherwise all the other values will be returned as well. | ||
==Business Configuration== | ==Business Configuration== | ||
Revision as of 11:25, 23 March 2015
Below you will see a list of each official module produced by Cliquesoft. Clicking on a module name from the list will take you to the appropriate section that outlines the various API's used by the modules' graphical frontend. It is important to note that the 'username' and 'SID' values should be passed for every communication with the server, even if they are null values (which will default to the 'guest' account). Also, all the mentioned parameters that are encapsulated with parenthesis are optional. Any questions, comments, or concerns should be directed to our staff.
Contents
Dashboard
System Configuration
Load the interface
To load the modules default HTML interface (themes/default/webbooks.system_configuration.html), the below parameters should be passed. Loading an alternative screen relies on the symlinks set in the users data directory (e.g. data/_guest/_theme/{images|layout|styles}).
action=init target=screen username= SID=
This will return the raw contents as it is found in the file, replacing all occurrences of the variable ${UN} anywhere.
Populate the form
To populate all the various values of the interface form objects, the below parameters will need to be passed.
action=init target=values username= SID=
This will return all the information in the following XML layout:
<general>
<admin id="INTEGER" name="STRING" type="{provider|vendor|employee}" email="STRING" phone="INTEGER" ext="INTEGER" mobile="INTEGER" sms="{0|1}" mail="{0|1}" />
<system socialURI="STRING" [accessURI="STRING" logins="INTEGER" support="STRING" balance="DECIMAL" prefix="STRING"] />
</general>
The <system> tag has only one mandatory value (socialURI) when the software is not working in a HOSTED mode, otherwise all the other values will be returned as well.
