To use the TermWeb API, your TermWeb license must include XML-RPC API. You can check you license details by going to Admin View - License. XML-RPC API should be enabled.
The API is accessed by using the same user credentials (client login, user name and password) as for normal logins. It is recommended to use one or more dedicated user account(s) for API access, since API log in will terminate any other session for that user.
Users accessing the API must have API access enabled for at least one group. Edit the group and make sure Allow API access is checked.
To allow API access for all users you can edit All Users group and check Allow API access there.
The connection URL for the XML-RPC API is defined in TermWeb's web.xml
file
|
If you wish to change the URL where the API is located, you can edit the <url-pattern>
value and then restart TermWeb.
These are the steps to use the API:
Connect to the API
Create a new session for a user
Call the desired methods, passing the session ID as argument
Close the session
The TermWeb API is configured at the URI /termweb/api
by default, so if your TermWeb is installed at http://myserver.example.com/termweb
the API is found at http://myserver.example.com/termweb/api
.
The TermWeb API uses the prefix termwebapi2
for all methods.
The API URI can be modified in the web.xml file. See Getting started.
Connect to the TermWeb server:
|
Create a new session for guest user:
|
Response:
|
Close the session:
|
Response:
|
Method | Description | Returns | Return type |
---|---|---|---|
| Creates a new session for a Guest user with auto-login enabled. | SessionID |
|
| Creates a new session for the guest user for specified client login. | SessionID |
|
| Creates a new session for the specified client login, user name and password. | SessionID |
|
| Closes a session (logs out user) on the server. | 0 |
|
| Returns the version of the API from the server. | The version string |
|
| Returns the TermWeb version from the server. | The version string |
|