Getting started

Owned by Patrik Westlund
Feb 25, 2016

License

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.

User credentials

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.

Allow access for group

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.

URL Configuration

The connection URL for the XML-RPC API is defined in TermWeb's web.xml file

<servlet>
  <servlet-name>TermWebAPI</servlet-name>
  <servlet-class>org.termweb.api.internal.TermWebAPIServlet</servlet-class>
</servlet>
...
<servlet-mapping>
  <servlet-name>TermWebAPI</servlet-name>
  <url-pattern>/api</url-pattern>
</servlet-mapping>

If you wish to change the URL where the API is located, you can edit the <url-pattern> value and then restart TermWeb.

Â